You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
# pkg-up [![Build Status](https://travis-ci.org/sindresorhus/pkg-up.svg?branch=master)](https://travis-ci.org/sindresorhus/pkg-up)
> Find the closest package.json file
## Install
``` $ npm install pkg-up ```
## Usage
``` / └── Users └── sindresorhus └── foo ├── package.json └── bar ├── baz └── example.js ```
```js // example.js const pkgUp = require('pkg-up');
(async () => { console.log(await pkgUp()); //=> '/Users/sindresorhus/foo/package.json' })(); ```
## API
### pkgUp([options])
Returns a `Promise<string>` for the filepath, or `Promise<null>` if it couldn't be found.
### pkgUp.sync([options])
Returns the filepath, or `null` if it couldn't be found.
#### options
Type: `Object`
#### cwd
Type: `string`<br> Default: `process.cwd()`
Directory to start from.
## Related
- [read-pkg-up](https://github.com/sindresorhus/read-pkg-up) - Read the closest package.json file - [pkg-dir](https://github.com/sindresorhus/pkg-dir) - Find the root directory of an npm package - [find-up](https://github.com/sindresorhus/find-up) - Find a file by walking up parent directories
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)
|