index.d.ts
1.26 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
declare namespace globalDirectories {
interface GlobalDirectories {
/**
Directory with globally installed packages.
Equivalent to `npm root --global`.
*/
readonly packages: string;
/**
Directory with globally installed binaries.
Equivalent to `npm bin --global`.
*/
readonly binaries: string;
/**
Directory with directories for packages and binaries. You probably want either of the above.
Equivalent to `npm prefix --global`.
*/
readonly prefix: string;
}
}
declare const globalDirectories: {
/**
Get the directory of globally installed packages and binaries.
@example
```
import globalDirectories = require('global-dirs');
console.log(globalDirectories.npm.prefix);
//=> '/usr/local'
console.log(globalDirectories.npm.packages);
//=> '/usr/local/lib/node_modules'
```
*/
readonly npm: globalDirectories.GlobalDirectories;
/**
Get the directory of globally installed packages and binaries.
@example
```
import globalDirectories = require('global-dirs');
console.log(globalDirectories.npm.binaries);
//=> '/usr/local/bin'
console.log(globalDirectories.yarn.packages);
//=> '/Users/sindresorhus/.config/yarn/global/node_modules'
```
*/
readonly yarn: globalDirectories.GlobalDirectories;
}
export = globalDirectories;