diff options
author | Minteck <contact@minteck.org> | 2022-06-04 08:51:01 +0200 |
---|---|---|
committer | Minteck <contact@minteck.org> | 2022-06-04 08:51:01 +0200 |
commit | 383285ecd5292bf9a825e05904955b937de84cc9 (patch) | |
tree | 0a53b6f02c1604b078044567c03dc1b6c944c8c2 /node_modules/global-dirs/index.d.ts | |
download | equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.gz equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.bz2 equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.zip |
Initial commit
Diffstat (limited to 'node_modules/global-dirs/index.d.ts')
-rw-r--r-- | node_modules/global-dirs/index.d.ts | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/node_modules/global-dirs/index.d.ts b/node_modules/global-dirs/index.d.ts new file mode 100644 index 0000000..ac39a23 --- /dev/null +++ b/node_modules/global-dirs/index.d.ts @@ -0,0 +1,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; |