aboutsummaryrefslogtreecommitdiff
path: root/node_modules/pkg-dir/index.d.ts
diff options
context:
space:
mode:
authorJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
committerJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
commit080c5819d87b933816d724a83f3bf4f1686770a7 (patch)
tree4a2ccc68b27edf7d4cbc586c932cc7542b655e19 /node_modules/pkg-dir/index.d.ts
parent5ac7049a9d30733165cc212dee308163c2a14644 (diff)
parentd003b82235a9329f912522a2f70aa950dfce4998 (diff)
downloadLYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.tar.gz
LYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.zip
Merge branch 'master' of https://github.com/JoelHMikael/FoodJS
Updating remote changes
Diffstat (limited to 'node_modules/pkg-dir/index.d.ts')
-rw-r--r--node_modules/pkg-dir/index.d.ts44
1 files changed, 44 insertions, 0 deletions
diff --git a/node_modules/pkg-dir/index.d.ts b/node_modules/pkg-dir/index.d.ts
new file mode 100644
index 0000000..e339404
--- /dev/null
+++ b/node_modules/pkg-dir/index.d.ts
@@ -0,0 +1,44 @@
+declare const pkgDir: {
+ /**
+ Find the root directory of a Node.js project or npm package.
+
+ @param cwd - Directory to start from. Default: `process.cwd()`.
+ @returns The project root path or `undefined` if it couldn't be found.
+
+ @example
+ ```
+ // /
+ // └── Users
+ // └── sindresorhus
+ // └── foo
+ // ├── package.json
+ // └── bar
+ // ├── baz
+ // └── example.js
+
+ // example.js
+ import pkgDir = require('pkg-dir');
+
+ (async () => {
+ const rootDir = await pkgDir(__dirname);
+
+ console.log(rootDir);
+ //=> '/Users/sindresorhus/foo'
+ })();
+ ```
+ */
+ (cwd?: string): Promise<string | undefined>;
+
+ /**
+ Synchronously find the root directory of a Node.js project or npm package.
+
+ @param cwd - Directory to start from. Default: `process.cwd()`.
+ @returns The project root path or `undefined` if it couldn't be found.
+ */
+ sync(cwd?: string): string | undefined;
+
+ // TODO: Remove this for the next major release
+ default: typeof pkgDir;
+};
+
+export = pkgDir;