pkg-dir

Functions

• packageDirectory()
• packageDirectorySync()

Type Aliases

• Options

function packageDirectory

packageDirectory: (options?: Options) => Promise<string | undefined>;

• 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 1

  // /
  // └── Users
  //     └── sindresorhus
  //         └── foo
  //             ├── package.json
  //             └── bar
  //                 ├── baz
  //                 └── example.js
  
  // example.js
  import {packageDirectory} from 'pkg-dir';
  
  console.log(await packageDirectory());
  //=> '/Users/sindresorhus/foo'

function packageDirectorySync

packageDirectorySync: (options?: Options) => 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 1

  // /
  // └── Users
  //     └── sindresorhus
  //         └── foo
  //             ├── package.json
  //             └── bar
  //                 ├── baz
  //                 └── example.js
  
  // example.js
  import {packageDirectorySync} from 'pkg-dir';
  
  console.log(packageDirectorySync());
  //=> '/Users/sindresorhus/foo'

type Options

type Options = {
    /**
	The directory to start searching from.

	@default process.cwd()
	*/
    readonly cwd?: string;
};