aboutsummaryrefslogtreecommitdiff
path: root/node_modules/pkg-dir/index.d.ts
diff options
context:
space:
mode:
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;