os-paths

os-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 os-paths

Usage

const osPaths = require('os-paths');

const paths = osPaths('MyApp');

paths.data;
//=> '/home/rivy/.local/share/MyApp-nodejs'

paths.config
//=> '/home/rivy/.config/MyApp-nodejs'

API

paths = osPaths(name, [options])

Note: It only generates the path strings. It doesn't create the directories for you. You could use make-dir to create the directories.

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.

License

MIT © Roy Ivy III, Sindre Sorhus