Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
36ccc22
commit d36cb78
Showing
8 changed files
with
94 additions
and
121 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,57 +1,40 @@ | ||
declare namespace pReduce { | ||
type ReducerFunction<ValueType, ReducedValueType = ValueType> = ( | ||
previousValue: ReducedValueType, | ||
currentValue: ValueType, | ||
index: number | ||
) => PromiseLike<ReducedValueType> | ReducedValueType; | ||
} | ||
|
||
declare const pReduce: { | ||
/** | ||
Reduce a list of values using promises into a promise for a value. | ||
@param input - Iterated over serially in the `reducer` function. | ||
@param reducer - Expected to return a value. If a `Promise` is returned, it's awaited before continuing with the next iteration. | ||
@param initialValue - Value to use as `previousValue` in the first `reducer` invocation. | ||
@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 resolved value is the result of the reduction. | ||
@example | ||
``` | ||
import pReduce = require('p-reduce'); | ||
import humanInfo from 'human-info'; // Not a real module | ||
(async () => { | ||
const names = [ | ||
getUser('sindresorhus').then(info => info.name), | ||
'Addy Osmani', | ||
'Pascal Hartig', | ||
'Stephen Sawchuk' | ||
]; | ||
const totalAge = await pReduce(names, async (total, name) => { | ||
const info = await humanInfo(name); | ||
return total + info.age; | ||
}, 0); | ||
console.log(totalAge); | ||
//=> 125 | ||
})(); | ||
``` | ||
*/ | ||
<ValueType, ReducedValueType = ValueType>( | ||
input: Iterable<PromiseLike<ValueType> | ValueType>, | ||
reducer: pReduce.ReducerFunction<ValueType, ReducedValueType>, | ||
initialValue?: ReducedValueType | ||
): Promise<ReducedValueType>; | ||
|
||
// TODO: Remove this for the next major release, refactor the whole definition to: | ||
// declare function pReduce<ValueType, ReducedValueType = ValueType>( | ||
// input: Iterable<PromiseLike<ValueType> | ValueType>, | ||
// reducer: pReduce.ReducerFunction<ValueType, ReducedValueType>, | ||
// initialValue?: ReducedValueType | ||
// ): Promise<ReducedValueType>; | ||
// export = pReduce; | ||
default: typeof pReduce; | ||
}; | ||
|
||
export = pReduce; | ||
export type ReducerFunction<ValueType, ReducedValueType = ValueType> = ( | ||
previousValue: ReducedValueType, | ||
currentValue: ValueType, | ||
index: number | ||
) => PromiseLike<ReducedValueType> | ReducedValueType; | ||
|
||
/** | ||
Reduce a list of values using promises into a promise for a value. | ||
@param input - Iterated over serially in the `reducer` function. | ||
@param reducer - Expected to return a value. If a `Promise` is returned, it's awaited before continuing with the next iteration. | ||
@param initialValue - Value to use as `previousValue` in the first `reducer` invocation. | ||
@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 resolved value is the result of the reduction. | ||
@example | ||
``` | ||
import pReduce from 'p-reduce'; | ||
import humanInfo from 'human-info'; // Not a real module | ||
const names = [ | ||
getUser('sindresorhus').then(info => info.name), | ||
'Addy Osmani', | ||
'Pascal Hartig', | ||
'Stephen Sawchuk' | ||
]; | ||
const totalAge = await pReduce(names, async (total, name) => { | ||
const info = await humanInfo(name); | ||
return total + info.age; | ||
}, 0); | ||
console.log(totalAge); | ||
//=> 125 | ||
``` | ||
*/ | ||
export default function pReduce<ValueType, ReducedValueType = ValueType>( | ||
input: Iterable<PromiseLike<ValueType> | ValueType>, | ||
reducer: ReducerFunction<ValueType, ReducedValueType>, | ||
initialValue?: ReducedValueType | ||
): Promise<ReducedValueType>; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,24 @@ | ||
'use strict'; | ||
export default async function pReduce(iterable, reducer, initialValue) { | ||
return new Promise((resolve, reject) => { | ||
const iterator = iterable[Symbol.iterator](); | ||
let index = 0; | ||
|
||
const pReduce = (iterable, reducer, initialValue) => new Promise((resolve, reject) => { | ||
const iterator = iterable[Symbol.iterator](); | ||
let index = 0; | ||
const next = async total => { | ||
const element = iterator.next(); | ||
|
||
const next = async total => { | ||
const element = iterator.next(); | ||
if (element.done) { | ||
resolve(total); | ||
return; | ||
} | ||
|
||
if (element.done) { | ||
resolve(total); | ||
return; | ||
} | ||
try { | ||
const [resolvedTotal, resolvedValue] = await Promise.all([total, element.value]); | ||
next(reducer(resolvedTotal, resolvedValue, index++)); | ||
} catch (error) { | ||
reject(error); | ||
} | ||
}; | ||
|
||
try { | ||
const value = await Promise.all([total, element.value]); | ||
next(reducer(value[0], value[1], index++)); | ||
} catch (error) { | ||
reject(error); | ||
} | ||
}; | ||
|
||
next(initialValue); | ||
}); | ||
|
||
module.exports = pReduce; | ||
// TODO: Remove this for the next major release | ||
module.exports.default = pReduce; | ||
next(initialValue); | ||
}); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters