| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485 |
- # find-up [](https://travis-ci.org/sindresorhus/find-up) [](https://ci.appveyor.com/project/sindresorhus/find-up/branch/master)
- > Find a file by walking up parent directories
- ## Install
- ```
- $ npm install --save find-up
- ```
- ## Usage
- ```
- /
- └── Users
- └── sindresorhus
- ├── unicorn.png
- └── foo
- └── bar
- ├── baz
- └── example.js
- ```
- ```js
- // example.js
- const findUp = require('find-up');
- findUp('unicorn.png').then(filepath => {
- console.log(filepath);
- //=> '/Users/sindresorhus/unicorn.png'
- });
- findUp(['rainbow.png', 'unicorn.png']).then(filepath => {
- console.log(filepath);
- //=> '/Users/sindresorhus/unicorn.png'
- });
- ```
- ## API
- ### findUp(filename, [options])
- Returns a `Promise` for the filepath or `null`.
- ### findUp([filenameA, filenameB], [options])
- Returns a `Promise` for the first filepath found (by respecting the order) or `null`.
- ### findUp.sync(filename, [options])
- Returns a filepath or `null`.
- ### findUp.sync([filenameA, filenameB], [options])
- Returns the first filepath found (by respecting the order) or `null`.
- #### filename
- Type: `string`
- Filename of the file to find.
- #### options
- ##### cwd
- Type: `string`<br>
- Default: `process.cwd()`
- Directory to start from.
- ## Related
- - [find-up-cli](https://github.com/sindresorhus/find-up-cli) - CLI for this module
- - [pkg-up](https://github.com/sindresorhus/pkg-up) - Find the closest package.json file
- - [pkg-dir](https://github.com/sindresorhus/pkg-dir) - Find the root directory of an npm package
- ## License
- MIT © [Sindre Sorhus](https://sindresorhus.com)
|
