| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899 |
- # locate-path [](https://travis-ci.org/sindresorhus/locate-path)
- > Get the first path that exists on disk of multiple paths
- ## Install
- ```
- $ npm install locate-path
- ```
- ## Usage
- Here we find the first file that exists on disk, in array order.
- ```js
- const locatePath = require('locate-path');
- const files = [
- 'unicorn.png',
- 'rainbow.png', // Only this one actually exists on disk
- 'pony.png'
- ];
- (async () => {
- console(await locatePath(files));
- //=> 'rainbow'
- })();
- ```
- ## API
- ### locatePath(input, [options])
- Returns a `Promise` for the first path that exists or `undefined` if none exists.
- #### input
- Type: `Iterable<string>`
- Paths to check.
- #### options
- Type: `Object`
- ##### concurrency
- Type: `number`<br>
- Default: `Infinity`<br>
- Minimum: `1`
- Number of concurrently pending promises.
- ##### preserveOrder
- Type: `boolean`<br>
- Default: `true`
- Preserve `input` order when searching.
- Disable this to improve performance if you don't care about the order.
- ##### cwd
- Type: `string`<br>
- Default: `process.cwd()`
- Current working directory.
- ### locatePath.sync(input, [options])
- Returns the first path that exists or `undefined` if none exists.
- #### input
- Type: `Iterable<string>`
- Paths to check.
- #### options
- Type: `Object`
- ##### cwd
- Same as above.
- ## Related
- - [path-exists](https://github.com/sindresorhus/path-exists) - Check if a path exists
- ## License
- MIT © [Sindre Sorhus](https://sindresorhus.com)
|
