peach a19a732be8 commit message | 2 سال پیش | |
---|---|---|
.. | ||
index.d.ts | 2 سال پیش | |
index.js | 2 سال پیش | |
license | 2 سال پیش | |
package.json | 2 سال پیش | |
readme.md | 2 سال پیش |
Get the first fulfilled promise that satisfies the provided testing function
Think of it like an async version of Array#find
.
$ npm install p-locate
Here we find the first file that exists on disk, in array order.
const pathExists = require('path-exists');
const pLocate = require('p-locate');
const files = [
'unicorn.png',
'rainbow.png', // Only this one actually exists on disk
'pony.png'
];
(async () => {
const foundPath = await pLocate(files, file => pathExists(file));
console.log(foundPath);
//=> 'rainbow'
})();
The above is just an example. Use locate-path
if you need this.
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
.
Type: Iterable<Promise | unknown>
An iterable of promises/values to test.
Type: Function
This function will receive resolved values from input
and is expected to return a Promise<boolean>
or boolean
.
Type: Object
Type: number
Default: Infinity
Minimum: 1
Number of concurrently pending promises returned by tester
.
Type: boolean
Default: true
Preserve input
order when searching.
Disable this to improve performance if you don't care about the order.
MIT © Sindre Sorhus