Numerous Philanthropic Misanthropes

    env-paths
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    env-paths Build Status

    Get paths for storing things like data, config, cache, etc

    Install

    $ npm install --save env-paths
    

    Usage

    const envPaths = require('env-paths');
    const paths = envPaths('MyApp');
    
    paths.data;
    //=> '/home/sindresorhus/.local/share/MyApp-nodejs'
    
    paths.config
    //=> '/home/sindresorhus/.config/MyApp-nodejs'

    API

    paths = envPaths(name, [options])

    name

    Type: string

    Name of your project. Used to generate the paths.

    options

    suffix

    Type: string
    Default: 'nodejs'

    Don't use this option unless you really have to!
    Suffix appended to the project name to avoid name conflicts with native apps. Pass an empty string to disable it.

    paths.data

    Directory for data files.

    paths.config

    Directory for config files.

    paths.cache

    Directory for non-essential data files.

    paths.log

    Directory for log files.

    paths.temp

    Directory for temporary files.

    License

    MIT © Sindre Sorhus

    Install

    npm i env-paths@1.0.0

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • sindresorhus