https://github.com/kevva/p-every
Test whether all promises passes a testing function
https://github.com/kevva/p-every
async async-await async-functions concurrency iteration nodejs parallel promise
Last synced: about 2 months ago
JSON representation
Test whether all promises passes a testing function
- Host: GitHub
- URL: https://github.com/kevva/p-every
- Owner: kevva
- License: mit
- Created: 2017-05-24T01:17:35.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-15T09:22:41.000Z (about 6 years ago)
- Last Synced: 2025-03-12T23:32:33.010Z (2 months ago)
- Topics: async, async-await, async-functions, concurrency, iteration, nodejs, parallel, promise
- Language: JavaScript
- Size: 8.79 KB
- Stars: 12
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# p-every [](https://travis-ci.org/kevva/p-every)
> Test whether all promises passes a testing function
Like [`Array.every`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every) for promises.
## Install
```
$ npm install --save p-every
```
## Usage
```js
const pEvery = require('p-every');
const getContinent = require('get-continent'); // not a real module
const places = [
getCapital('Norway').then(info => info.name),
'Bangkok, Thailand',
'Berlin, Germany',
'Tokyo, Japan'
];
const testFunction = async place => {
const continent = await getContinent(place);
return continent === 'europe';
}
(async () => {
const result = await pEvery(places, testFunction);
console.log(result);
//=> false
})();
```
## API
### pEvery(input, testFunction, [options])
Returns a `Promise` that is fulfilled when all promises 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 all Promises passed the test and `false` otherwise.
#### input
Type: `Iterable`
Iterated over concurrently in the `testFunction` function.
#### testFunction(element, index)
Type: `Function`
Predicate function, expected to return a `Promise` or `boolean`.
#### options
Type: `Object`
##### concurrency
Type: `number`
Default: `Infinity`
Minimum: `1`
Number of concurrently pending promises returned by `testFunction`.
## Related
* [p-filter](https://github.com/sindresorhus/p-filter) - Filter promises concurrently
* [p-locate](https://github.com/sindresorhus/p-locate) - Get the first fulfilled promise that satisfies the provided testing function
* [p-map](https://github.com/sindresorhus/p-map) - Map over promises concurrently
* [More…](https://github.com/sindresorhus/promise-fun)
## License
MIT © [Kevin Martensson](http://github.com/kevva)