aboutsummaryrefslogtreecommitdiff
path: root/node_modules/pkg-dir/readme.md
diff options
context:
space:
mode:
authorJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
committerJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
commit5d309ff52cd399a6b71968a6b9a70c8ac0b98981 (patch)
tree360f7eb50f956e2367ef38fa1fc6ac7ac5258042 /node_modules/pkg-dir/readme.md
parentb500a50f1b97d93c98b36ed9a980f8188d648147 (diff)
downloadLYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.tar.gz
LYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.zip
Added node_modules for the updating to work properly.
Diffstat (limited to 'node_modules/pkg-dir/readme.md')
-rw-r--r--node_modules/pkg-dir/readme.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/node_modules/pkg-dir/readme.md b/node_modules/pkg-dir/readme.md
new file mode 100644
index 0000000..92a77f4
--- /dev/null
+++ b/node_modules/pkg-dir/readme.md
@@ -0,0 +1,66 @@
+# pkg-dir [![Build Status](https://travis-ci.org/sindresorhus/pkg-dir.svg?branch=master)](https://travis-ci.org/sindresorhus/pkg-dir)
+
+> Find the root directory of a Node.js project or npm package
+
+
+## Install
+
+```
+$ npm install pkg-dir
+```
+
+
+## Usage
+
+```
+/
+└── Users
+ └── sindresorhus
+ └── foo
+ ├── package.json
+ └── bar
+ ├── baz
+ └── example.js
+```
+
+```js
+// example.js
+const pkgDir = require('pkg-dir');
+
+(async () => {
+ const rootDir = await pkgDir(__dirname);
+
+ console.log(rootDir);
+ //=> '/Users/sindresorhus/foo'
+})();
+```
+
+
+## API
+
+### pkgDir([cwd])
+
+Returns a `Promise` for either the project root path or `undefined` if it couldn't be found.
+
+### pkgDir.sync([cwd])
+
+Returns the project root path or `undefined` if it couldn't be found.
+
+#### cwd
+
+Type: `string`<br>
+Default: `process.cwd()`
+
+Directory to start from.
+
+
+## Related
+
+- [pkg-dir-cli](https://github.com/sindresorhus/pkg-dir-cli) - CLI for this module
+- [pkg-up](https://github.com/sindresorhus/pkg-up) - Find the closest package.json file
+- [find-up](https://github.com/sindresorhus/find-up) - Find a file by walking up parent directories
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)