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.
import {pathExists} from 'path-exists';
import pLocate from 'p-locate';
const files = [
'unicorn.png',
'rainbow.png', // Only this one actually exists on disk
'pony.png'
];
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
The 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.
p-any is similar to p-locate in that it is designed to find the first promise that fulfills. The difference is that p-any does not provide a way to specify a condition; it simply returns the first promise that fulfills.
p-some is like p-locate but for multiple promises. It allows you to specify a count of how many fulfilling promises you want to find before returning, whereas p-locate will only find the first one.
promise-race is a function that behaves like Promise.race, but with an array of promises. It is similar to p-locate in that it returns the first promise that fulfills or rejects, but it does not allow for a condition to be specified.
FAQs
Get the first fulfilled promise that satisfies the provided testing function
The npm package p-locate receives a total of 177,892,902 weekly downloads. As such, p-locate popularity was classified as popular.
We found that p-locate demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket Firewall Enterprise is now available with flexible deployment, configurable policies, and expanded language support.
Security News
Open source dashboard CNAPulse tracks CVE Numbering Authorities’ publishing activity, highlighting trends and transparency across the CVE ecosystem.
Product
Detect malware, unsafe data flows, and license issues in GitHub Actions with Socket’s new workflow scanning support.