aboutsummaryrefslogtreecommitdiff
path: root/node_modules/global-dirs/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/global-dirs/readme.md')
-rw-r--r--node_modules/global-dirs/readme.md72
1 files changed, 72 insertions, 0 deletions
diff --git a/node_modules/global-dirs/readme.md b/node_modules/global-dirs/readme.md
new file mode 100644
index 0000000..0276ee1
--- /dev/null
+++ b/node_modules/global-dirs/readme.md
@@ -0,0 +1,72 @@
+# 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 globalDirectories = require('global-dirs');
+
+console.log(globalDirectories.npm.prefix);
+//=> '/usr/local'
+
+console.log(globalDirectories.npm.packages);
+//=> '/usr/local/lib/node_modules'
+
+console.log(globalDirectories.npm.binaries);
+//=> '/usr/local/bin'
+
+console.log(globalDirectories.yarn.packages);
+//=> '/Users/sindresorhus/.config/yarn/global/node_modules'
+```
+
+## API
+
+### globalDirectories
+
+#### 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
+
+---
+
+<div align="center">
+ <b>
+ <a href="https://tidelift.com/subscription/pkg/npm-global-dirs?utm_source=npm-global-dirs&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
+ </b>
+ <br>
+ <sub>
+ Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
+ </sub>
+</div>