p-one

Test whether some promise passes a testing function

Like Array.some for promises.

Install

$ npm install --save p-one

Usage

1const pOne = require('p-one');
2const getContinent = require('get-continent'); // not a real module
3
4const places = [
5	getCapital('Norway').then(info => info.name),
6	'Bangkok, Thailand',
7	'Berlin, Germany',
8	'Tokyo, Japan'
9];
10
11const testFunction = async place => {
12	const continent = await getContinent(place);
13	return continent === 'europe';
14}
15
16(async () => {
17	const result = await pOne(places, testFunction)
18	console.log(result);
19	//=> true
20})();

API

pOne(input, testFunction, [options])

Returns a Promise that is fulfilled when any promise in input and ones returned from testFunction are fulfilled, or rejects if any of the promises reject. The fulfilled value is a boolean that is true if any promise passed the test and false otherwise.

input

Type: Iterable<Promise|any>

Iterated over concurrently in the testFunction function.

testFunction(element, index)

Type: Function

Expected to return a Promise<boolean> or boolean.

options

Type: Object

concurrency

Type: number
Default: Infinity
Minimum: 1

Number of concurrently pending promises returned by testFunction.

Related

• p-every - Test whether all promises passes a testing function
• p-filter - Filter promises concurrently
• p-locate - Get the first fulfilled promise that satisfies the provided testing function
• p-map - Map over promises concurrently
• More…

License

MIT © Kevin Martensson