mirror of https://github.com/nodejs/node.git synced 2025-05-17 06:08:35 +00:00

History

Myles Borins 2e54524955 deps: update npm to 7.0.0-rc.3 PR-URL: https://github.com/nodejs/node/pull/35474 Reviewed-By: Ruy Adorno <ruyadorno@github.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Ben Coe <bencoe@gmail.com> Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com> Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>		2020-10-07 09:59:49 -04:00
..
index.d.ts	deps: upgrade npm to 6.13.7	2020-01-31 18:52:20 -08:00
index.js	deps: upgrade npm to 6.13.7	2020-01-31 18:52:20 -08:00
license	deps: upgrade npm to 6.13.7	2020-01-31 18:52:20 -08:00
package.json	deps: update npm to 7.0.0-rc.3	2020-10-07 09:59:49 -04:00
readme.md	deps: upgrade npm to 6.13.7	2020-01-31 18:52:20 -08:00

readme.md

env-paths

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

Uses the correct OS-specific paths. Most developers get this wrong.

Install

$ npm install 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

Type: Object

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.