index.d.ts
1.53 KB
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
declare const xdgBasedir: {
/**
Directory for user-specific data files.
@example
```js
import xdgBasedir = require('xdg-basedir');
xdgBasedir.data;
//=> '/home/sindresorhus/.local/share'
```
*/
readonly data?: string;
/**
Directory for user-specific configuration files.
@example
```js
import xdgBasedir = require('xdg-basedir');
xdgBasedir.config;
//=> '/home/sindresorhus/.config'
```
*/
readonly config?: string;
/**
Directory for user-specific non-essential data files.
@example
```js
import xdgBasedir = require('xdg-basedir');
xdgBasedir.cache;
//=> '/home/sindresorhus/.cache'
```
*/
readonly cache?: string;
/**
Directory for user-specific non-essential runtime files and other file objects (such as sockets, named pipes, etc).
@example
```js
import xdgBasedir = require('xdg-basedir');
xdgBasedir.runtime;
//=> '/run/user/sindresorhus'
```
*/
readonly runtime?: string;
/**
Preference-ordered array of base directories to search for data files in addition to `.data`.
@example
```js
import xdgBasedir = require('xdg-basedir');
xdgBasedir.dataDirs
//=> ['/home/sindresorhus/.local/share', '/usr/local/share/', '/usr/share/']
```
*/
readonly dataDirs: readonly string[];
/**
Preference-ordered array of base directories to search for configuration files in addition to `.config`.
@example
```js
import xdgBasedir = require('xdg-basedir');
xdgBasedir.configDirs;
//=> ['/home/sindresorhus/.config', '/etc/xdg']
```
*/
readonly configDirs: readonly string[];
};
export = xdgBasedir;