Skip to content

consume() function

与えられた数の Iterable/AsyncIterable を消費します。数が空の場合は、すべてが消費されます。

Signature:

typescript
declare function consume<
  A extends Iterable<unknown> | AsyncIterable<unknown>,
  B extends number,
>(iterator: A, n?: B): ReturnValueType<A, void>;

Example

ts
const iterator = (function* () {
  yield 1;
  yield 2;
  yield 3;
})();
consume(iterator, 2);
iterator.next(); // {value:3, done:false}
iterator.next(); // {value:undefined, done:true}

// with pipe
pipe(range(10), peek(updateApi), concurrent(5), consume);

Open Source Code

Released under the Apache-2.0 License.