2022-11-10 13:06:47 +00:00
# p-locate [![Build Status](https://travis-ci.org/sindresorhus/p-locate.svg?branch=master)](https://travis-ci.org/sindresorhus/p-locate)
2020-08-25 23:57:08 +00:00
> Get the first fulfilled promise that satisfies the provided testing function
Think of it like an async version of [`Array#find` ](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/find ).
2022-11-10 13:06:47 +00:00
2020-08-25 23:57:08 +00:00
## Install
```
2022-11-10 10:43:16 +00:00
$ npm install p-locate
2020-08-25 23:57:08 +00:00
```
2022-11-10 13:06:47 +00:00
2020-08-25 23:57:08 +00:00
## Usage
Here we find the first file that exists on disk, in array order.
```js
const pathExists = require('path-exists');
const pLocate = require('p-locate');
const files = [
'unicorn.png',
2022-11-10 10:43:16 +00:00
'rainbow.png', // Only this one actually exists on disk
2020-08-25 23:57:08 +00:00
'pony.png'
];
2022-11-10 10:43:16 +00:00
(async () => {
const foundPath = await pLocate(files, file => pathExists(file));
2020-08-25 23:57:08 +00:00
console.log(foundPath);
//=> 'rainbow'
2022-11-10 10:43:16 +00:00
})();
2020-08-25 23:57:08 +00:00
```
*The above is just an example. Use [`locate-path` ](https://github.com/sindresorhus/locate-path ) if you need this.*
2022-11-10 13:06:47 +00:00
2020-08-25 23:57:08 +00:00
## API
2022-11-10 13:06:47 +00:00
### pLocate(input, tester, [options])
2020-08-25 23:57:08 +00:00
Returns a `Promise` that is fulfilled when `tester` resolves to `true` or the iterable is done, or rejects if any of the promises reject. The fulfilled value is the current iterable value or `undefined` if `tester` never resolved to `true` .
#### input
2022-11-10 10:43:16 +00:00
Type: `Iterable<Promise | unknown>`
An iterable of promises/values to test.
2020-08-25 23:57:08 +00:00
#### tester(element)
Type: `Function`
2022-11-10 10:43:16 +00:00
This function will receive resolved values from `input` and is expected to return a `Promise<boolean>` or `boolean` .
2020-08-25 23:57:08 +00:00
#### options
2022-11-10 13:06:47 +00:00
Type: `Object`
2020-08-25 23:57:08 +00:00
##### concurrency
2022-11-10 13:06:47 +00:00
Type: `number` < br >
Default: `Infinity` < br >
2020-08-25 23:57:08 +00:00
Minimum: `1`
Number of concurrently pending promises returned by `tester` .
##### preserveOrder
2022-11-10 13:06:47 +00:00
Type: `boolean` < br >
2020-08-25 23:57:08 +00:00
Default: `true`
Preserve `input` order when searching.
Disable this to improve performance if you don't care about the order.
2022-11-10 13:06:47 +00:00
2020-08-25 23:57:08 +00:00
## Related
- [p-map ](https://github.com/sindresorhus/p-map ) - Map over promises concurrently
- [p-filter ](https://github.com/sindresorhus/p-filter ) - Filter promises concurrently
- [p-any ](https://github.com/sindresorhus/p-any ) - Wait for any promise to be fulfilled
- [More… ](https://github.com/sindresorhus/promise-fun )
2022-11-10 13:06:47 +00:00
## License
MIT © [Sindre Sorhus ](https://sindresorhus.com )