12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758 |
- export interface Options {
- /**
- The directory to start searching from.
- @default process.cwd()
- */
- readonly cwd?: string;
- }
- /**
- Find the root directory of a Node.js project or npm package.
- @returns The project root path or `undefined` if it could not be found.
- @example
- ```
- // /
- // └── Users
- // └── sindresorhus
- // └── foo
- // ├── package.json
- // └── bar
- // ├── baz
- // └── example.js
- // example.js
- import {packageDirectory} from 'pkg-dir';
- console.log(await packageDirectory());
- //=> '/Users/sindresorhus/foo'
- ```
- */
- export function packageDirectory(options?: Options): Promise<string | undefined>;
- /**
- Synchronously find the root directory of a Node.js project or npm package.
- @returns The project root path or `undefined` if it could not be found.
- @example
- ```
- // /
- // └── Users
- // └── sindresorhus
- // └── foo
- // ├── package.json
- // └── bar
- // ├── baz
- // └── example.js
- // example.js
- import {packageDirectorySync} from 'pkg-dir';
- console.log(packageDirectorySync());
- //=> '/Users/sindresorhus/foo'
- ```
- */
- export function packageDirectorySync(options?: Options): string | undefined;
|