global-directory/index.d.ts at main · sindresorhus/global-directory · GitHub

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
export type GlobalDirectory = {
	/**
	The directory with globally installed packages.

	Equivalent to `npm root --global`.
	*/
	readonly packages: string;

	/**
	The directory with globally installed binaries.

	Equivalent to `npm bin --global`.
	*/
	readonly binaries: string;

	/**
	The directory with directories for packages and binaries. You probably want either of the above.

	Equivalent to `npm prefix --global`.
	*/
	readonly prefix: string;
};

declare const globalDirectory: {
	/**
	Get the directory of globally installed packages and binaries.

	@example
	```
	import globalDirectory from 'global-directory';

	console.log(globalDirectory.npm.prefix);
	//=> '/usr/local'

	console.log(globalDirectory.npm.packages);
	//=> '/usr/local/lib/node_modules'
	```
	*/
	readonly npm: GlobalDirectory;

	/**
	Get the directory of globally installed packages and binaries.

	@example
	```
	import globalDirectory from 'global-directory';

	console.log(globalDirectory.npm.binaries);
	//=> '/usr/local/bin'

	console.log(globalDirectory.yarn.packages);
	//=> '/Users/sindresorhus/.config/yarn/global/node_modules'
	```
	*/
	readonly yarn: GlobalDirectory;

	/**
	Get the directory of globally installed packages and binaries.

	@example
	```
	import globalDirectory from 'global-directory';

	console.log(globalDirectory.pnpm.prefix);
	//=> '/Users/sindresorhus/Library/pnpm'

	console.log(globalDirectory.pnpm.packages);
	//=> '/Users/sindresorhus/Library/pnpm/global/5/node_modules'
	```
	*/
	readonly pnpm: GlobalDirectory;
};

export default globalDirectory;