Options
All
  • Public
  • Public/Protected
  • All
Menu

Module iterable/consume

Index

Functions

Functions

  • consume<T>(iterable: Iterable<T>, atMost?: number): [T[], Iterable<T>]
  • Consumes atMost elements from iterable and returns the consumed elements, and an iterable for the rest of the elements.

    example
     consume([1, 2, 3, 4]);        //=> [[1, 2, 3, 4], Iterable<[]>]
    consume([1, 2, 3, 4], 2); //=> [[1, 2], Iterable<[3, 4]>]

    Type parameters

    • T

    Parameters

    • iterable: Iterable<T>

      The iterable target to consume

    • atMost: number = Number.POSITIVE_INFINITY

      The count at most to consume

    Returns [T[], Iterable<T>]

Generated using TypeDoc