summaryrefslogtreecommitdiffstats
path: root/node_modules/global-dirs/readme.md
diff options
context:
space:
mode:
authorGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
committerGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
commite06ec920f7a5d784e674c4c4b4e6d1da3dc7391d (patch)
tree55713f725f77b44ebfec86e4eec3ce33e71458ca /node_modules/global-dirs/readme.md
downloadwebsite_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.gz
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.bz2
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.zip
api, login, auth
Diffstat (limited to 'node_modules/global-dirs/readme.md')
-rw-r--r--node_modules/global-dirs/readme.md69
1 files changed, 69 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..1acea6d
--- /dev/null
+++ b/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)