diff options
Diffstat (limited to 'node_modules/find-up/readme.md')
| -rw-r--r-- | node_modules/find-up/readme.md | 24 |
1 files changed, 11 insertions, 13 deletions
diff --git a/node_modules/find-up/readme.md b/node_modules/find-up/readme.md index 810ad7ceb..b5ad69455 100644 --- a/node_modules/find-up/readme.md +++ b/node_modules/find-up/readme.md @@ -1,12 +1,12 @@ # find-up [](https://travis-ci.org/sindresorhus/find-up) [](https://ci.appveyor.com/project/sindresorhus/find-up/branch/master) -> Find a file or directory by walking up parent directories +> Find a file by walking up parent directories ## Install ``` -$ npm install find-up +$ npm install --save find-up ``` @@ -23,18 +23,19 @@ $ npm install find-up └── example.js ``` -`example.js` - ```js +// example.js const findUp = require('find-up'); -(async () => { - console.log(await findUp('unicorn.png')); +findUp('unicorn.png').then(filepath => { + console.log(filepath); //=> '/Users/sindresorhus/unicorn.png' +}); - console.log(await findUp(['rainbow.png', 'unicorn.png'])); +findUp(['rainbow.png', 'unicorn.png']).then(filepath => { + console.log(filepath); //=> '/Users/sindresorhus/unicorn.png' -})(); +}); ``` @@ -42,11 +43,11 @@ const findUp = require('find-up'); ### findUp(filename, [options]) -Returns a `Promise` for either the filepath or `null` if it couldn't be found. +Returns a `Promise` for the filepath or `null`. ### findUp([filenameA, filenameB], [options]) -Returns a `Promise` for either the first filepath found (by respecting the order) or `null` if none could be found. +Returns a `Promise` for the first filepath found (by respecting the order) or `null`. ### findUp.sync(filename, [options]) @@ -64,8 +65,6 @@ Filename of the file to find. #### options -Type: `Object` - ##### cwd Type: `string`<br> @@ -79,7 +78,6 @@ Directory to start from. - [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 -- [resolve-from](https://github.com/sindresorhus/resolve-from) - Resolve the path of a module like `require.resolve()` but from a given path ## License |