Reduce a list of values using promises into a promise for a value
Branch: master
Clone or download
Latest commit fa526a9 Oct 20, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig init Oct 21, 2016
.gitattributes init Oct 21, 2016
.gitignore init Oct 21, 2016
.travis.yml init Oct 21, 2016
index.js init Oct 21, 2016
license init Oct 21, 2016
package.json 1.0.0 Oct 21, 2016
readme.md init Oct 21, 2016
test.js init Oct 21, 2016

readme.md

p-reduce Build Status

Reduce a list of values using promises into a promise for a value

Useful when you need to calculate some accumulated value based on async resources.

Install

$ npm install --save p-reduce

Usage

const pReduce = require('p-reduce');
const humanInfo = require('human-info'); // not a real module

const names = [
	getUser('sindresorhus').then(info => info.name),
	'Addy Osmani',
	'Pascal Hartig',
	'Stephen Sawchuk'
];

pReduce(names, (total, name) => {
	return humanInfo(name).then(info => total + info.age);
}, 0).then(totalAge => {
	console.log(totalAge);
	//=> 125
});

API

pReduce(input, reducer, [initialValue])

Returns a Promise that is fulfilled when all promises in input and ones returned from reducer are fulfilled, or rejects if any of the promises reject. The fulfilled value is the result of the reduction.

input

Type: Iterable<Promise|any>

Iterated over serially in the reducer function.

reducer(previousValue, currentValue, index)

Type: Function

Expected to return a value. If a Promise is returned, it's awaited before continuing with the next iteration.

initialValue

Type: any

Value to use as previousValue in the first reducer invocation.

Related

License

MIT © Sindre Sorhus