mirror of https://github.com/nodejs/node.git synced 2025-05-15 07:37:39 +00:00

History

isaacs d7d321b071 deps: upgrade npm to 6.10.2 PR-URL: https://github.com/nodejs/node/pull/28853 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>		2019-08-06 09:05:32 +02:00
..
index.js	deps: upgrade npm to 6.10.2	2019-08-06 09:05:32 +02:00
license	deps: upgrade npm to 6.10.2	2019-08-06 09:05:32 +02:00
package.json	deps: upgrade npm to 6.10.2	2019-08-06 09:05:32 +02:00
readme.md	deps: upgrade npm to 6.10.2	2019-08-06 09:05:32 +02:00

readme.md

env-paths

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.