Function: collectInto()
collectInto<
ElementType
>(iterable
:IterableResolvable
<ElementType
>,output
:ElementType
[]):ElementType
[]
Collects all the items from an iterator into an array.
This method consumes the iterator and adds all its items to the passed array. The array is then returned, so the call chain can be continued.
This is useful when you already have a collection and want to add the iterator items to it.
Type Parameters
Type Parameter |
---|
ElementType |
Parameters
Parameter | Type | Description |
---|---|---|
iterable | IterableResolvable <ElementType > | An iterator to fuse. |
output | ElementType [] | - |
Returns
ElementType
[]
Example
import { collectInto, map } from '@sapphire/iterator-utilities';
const iterable = [1, 2, 3];
const output = [0, 1];
collectInto(map(iterable, (value) => value * 2), output);
collectInto(map(iterable, (value) => value * 10), output);
console.log(output);
// Output: [0, 1, 2, 4, 6, 10, 20, 30]
Defined in
projects/utilities/packages/iterator-utilities/src/lib/collectInto.ts:28