blob: 61f8c16bedc00f3551f69c5b1ae746dc9fdccd53 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
# xdg-basedir [](https://travis-ci.org/sindresorhus/xdg-basedir)
> Get [XDG Base Directory](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) paths
## Install
```
$ npm install --save xdg-basedir
```
## Usage
```js
const xdgBasedir = require('xdg-basedir');
xdgBasedir.data;
//=> '/home/sindresorhus/.local/share'
xdgBasedir.config;
//=> '/home/sindresorhus/.config'
xdgBasedir.dataDirs
//=> ['/home/sindresorhus/.local/share', '/usr/local/share/', '/usr/share/']
```
## API
The properties `.data`, `.config`, `.cache`, `.runtime` will return `null` in the uncommon case that both the XDG environment variable is not set and the users home directory can't be found. You need to handle this case. A common solution is to [fall back to a temp directory](https://github.com/yeoman/configstore/blob/b82690fc401318ad18dcd7d151a0003a4898a314/index.js#L15).
### .data
Directory for user specific data files.
### .config
Directory for user specific configuration files.
### .cache
Directory for user specific non-essential data files.
### .runtime
Directory for user-specific non-essential runtime files and other file objects (such as sockets, named pipes, etc).
### .dataDirs
Preference-ordered array of base directories to search for data files in addition to `.data`.
### .configDirs
Preference-ordered array of base directories to search for configuration files in addition to `.config`.
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)
|
