diff options
Diffstat (limited to 'deps/node/deps/npm/node_modules/find-up/readme.md')
| -rw-r--r-- | deps/node/deps/npm/node_modules/find-up/readme.md | 85 |
1 files changed, 0 insertions, 85 deletions
diff --git a/deps/node/deps/npm/node_modules/find-up/readme.md b/deps/node/deps/npm/node_modules/find-up/readme.md deleted file mode 100644 index b5ad6945..00000000 --- a/deps/node/deps/npm/node_modules/find-up/readme.md +++ /dev/null @@ -1,85 +0,0 @@ -# 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) |