SWAMPy

✎ CARVE FLESH

EDITING: readme.md

# env-paths [![Build Status](https://travis-ci.org/sindresorhus/env-paths.svg?branch=master)](https://travis-ci.org/sindresorhus/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

```js
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`<br>
Default: `'nodejs'`

**Don't use this option unless you really have to!**<br>
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

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 index.d.ts	TS	1.4 KB	2021-03-10 14:36	EDIT
📄 index.js	JS	2.1 KB	2021-03-10 14:36	EDIT
📄 license	?	1.1 KB	2021-03-10 14:36	EDIT
📄 package.json	JSON	1.7 KB	2021-03-10 14:36	EDIT
📄 readme.md	MD	1.2 KB	2021-03-10 14:36	EDIT