61 lines
1.3 KiB
TypeScript
61 lines
1.3 KiB
TypeScript
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;
|