eslint-config-lemon

Version:
github.com/danielhuang/eslint-config-lemon
58 lines (44 loc) • 1.44 kB
TypeScript
declare const stop: unique symbol;

export type StopSymbol = typeof stop;

declare const pEachSeries: {
	/**
	Stop iterating through items by returning `pEachSeries.stop` from the iterator function.

	@example
	```
	import pEachSeries from 'p-each-series';

	// Logs `a` and `b`.
	const result = await pEachSeries(['a', 'b', 'c'], value => {
		console.log(value);

		if (value === 'b') {
			return pEachSeries.stop;
		}
	});

	console.log(result);
	//=> ['a', 'b', 'c']
	```
	*/
	readonly stop: StopSymbol;

	/**
	Iterate over promises serially.

	@param input - Iterated over serially in the `iterator` function.
	@param iterator - Return value is ignored unless it's `Promise`, then it's awaited before continuing with the next iteration.
	@returns A `Promise` that fulfills when all promises in `input` and ones returned from `iterator` are fulfilled, or rejects if any of the promises reject. The fulfillment value is the original `input`.

	@example
	```
	import pEachSeries from 'p-each-series';

	const keywords = [
		getTopKeyword(), //=> Promise
		'rainbow',
		'pony'
	];

	const iterator = async element => saveToDiskPromise(element);

	console.log(await pEachSeries(keywords, iterator));
	//=> ['unicorn', 'rainbow', 'pony']
	```
	*/
	<ValueType>(
		input: Iterable<PromiseLike<ValueType> | ValueType>,
		iterator: (element: ValueType, index: number) => StopSymbol | unknown
	): Promise<ValueType[]>;
};

export default pEachSeries;