summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/global-dirs/readme.md
diff options
context:
space:
mode:
authorRebecca Turner <me@re-becca.org>2018-04-20 18:26:37 -0700
committerMichaël Zasso <targos@protonmail.com>2018-05-25 14:03:01 +0200
commitd0cdcb61fe3a237be7d905cecc9ff1b95dbfdfa3 (patch)
tree9100e1f9c144368752be8c448d65bcd2bc8001a5 /deps/npm/node_modules/global-dirs/readme.md
parent1f3eb1cc1ec74b514f6e54fa88537818472bcb4d (diff)
downloadnode-new-d0cdcb61fe3a237be7d905cecc9ff1b95dbfdfa3.tar.gz
deps: upgrade npm to 6.1.0
PR-URL: https://github.com/nodejs/node/pull/20190 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
Diffstat (limited to 'deps/npm/node_modules/global-dirs/readme.md')
-rw-r--r--deps/npm/node_modules/global-dirs/readme.md69
1 files changed, 69 insertions, 0 deletions
diff --git a/deps/npm/node_modules/global-dirs/readme.md b/deps/npm/node_modules/global-dirs/readme.md
new file mode 100644
index 0000000000..1acea6d739
--- /dev/null
+++ b/deps/npm/node_modules/global-dirs/readme.md
@@ -0,0 +1,69 @@
+# global-dirs [![Build Status](https://travis-ci.org/sindresorhus/global-dirs.svg?branch=master)](https://travis-ci.org/sindresorhus/global-dirs)
+
+> Get the directory of globally installed packages and binaries
+
+Uses the same resolution logic as `npm` and `yarn`.
+
+
+## Install
+
+```
+$ npm install global-dirs
+```
+
+
+## Usage
+
+```js
+const globalDirs = require('global-dirs');
+
+console.log(globalDirs.npm.prefix);
+//=> '/usr/local'
+
+console.log(globalDirs.npm.packages);
+//=> '/usr/local/lib/node_modules'
+
+console.log(globalDirs.npm.binaries);
+//=> '/usr/local/bin'
+
+console.log(globalDirs.yarn.packages);
+//=> '/Users/sindresorhus/.config/yarn/global/node_modules'
+```
+
+
+## API
+
+### globalDirs
+
+#### npm
+#### yarn
+
+##### packages
+
+Directory with globally installed packages.
+
+Equivalent to `npm root --global`.
+
+##### binaries
+
+Directory with globally installed binaries.
+
+Equivalent to `npm bin --global`.
+
+##### prefix
+
+Directory with directories for packages and binaries. You probably want either of the above.
+
+Equivalent to `npm prefix --global`.
+
+
+## Related
+
+- [import-global](https://github.com/sindresorhus/import-global) - Import a globally installed module
+- [resolve-global](https://github.com/sindresorhus/resolve-global) - Resolve the path of a globally installed module
+- [is-installed-globally](https://github.com/sindresorhus/is-installed-globally) - Check if your package was installed globally
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)