/
index.d.ts
90 lines (70 loc) · 1.75 KB
/
index.d.ts
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
82
83
84
85
86
87
88
89
90
/**
Directory for user-specific data files.
@example
```
import {xdgData} from 'xdg-basedir';
console.log(xdgData);
//=> '/home/sindresorhus/.local/share'
```
*/
export const xdgData: string | undefined;
/**
Directory for user-specific configuration files.
@example
```
import {xdgConfig} from 'xdg-basedir';
console.log(xdgConfig);
//=> '/home/sindresorhus/.config'
```
*/
export const xdgConfig: string | undefined;
/**
Directory for user-specific state files.
@example
```
import {xdgState} from 'xdg-basedir';
console.log(xdgState);
//=> '/home/sindresorhus/.local/state'
```
*/
export const xdgState: string | undefined;
/**
Directory for user-specific non-essential data files.
@example
```
import {xdgCache} from 'xdg-basedir';
console.log(xdgCache);
//=> '/home/sindresorhus/.cache'
```
*/
export const xdgCache: string | undefined;
/**
Directory for user-specific non-essential runtime files and other file objects (such as sockets, named pipes, etc).
@example
```
import {xdgRuntime} from 'xdg-basedir';
console.log(xdgRuntime);
//=> '/run/user/sindresorhus'
```
*/
export const xdgRuntime: string | undefined;
/**
Preference-ordered array of base directories to search for data files in addition to `xdgData`.
@example
```
import {xdgDataDirectories} from 'xdg-basedir';
console.log(xdgDataDirectories);
//=> ['/home/sindresorhus/.local/share', '/usr/local/share/', '/usr/share/']
```
*/
export const xdgDataDirectories: readonly string[];
/**
Preference-ordered array of base directories to search for configuration files in addition to `xdgConfig`.
@example
```
import {xdgConfigDirectories} from 'xdg-basedir';
console.log(xdgConfigDirectories);
//=> ['/home/sindresorhus/.config', '/etc/xdg']
```
*/
export const xdgConfigDirectories: readonly string[];