it-length
Version:
Counts the number of items in an async iterable
41 lines • 894 B
TypeScript
/**
* @packageDocumentation
*
* Counts the number of items in an (async)iterable.
*
* N.b. will consume the iterable
*
* @example
*
* ```javascript
* import length from 'it-length'
*
* // This can also be an iterator, generator, etc
* const values = [0, 1, 2, 3, 4]
*
* const res = length(values)
*
* console.info(res) // 5
* ```
*
* Async sources must be awaited:
*
* ```javascript
* import length from 'it-length'
*
* const values = async function * () {
* yield * [0, 1, 2, 3, 4]
* }
*
* const res = await length(values())
*
* console.info(res) // 5
* ```
*/
/**
* Consumes the passed iterator and returns the number of items it contained
*/
declare function length(source: Iterable<unknown>): number;
declare function length(source: Iterable<unknown> | AsyncIterable<unknown>): Promise<number>;
export default length;
//# sourceMappingURL=index.d.ts.map