Index

Functions

chain

  • chain(...iterables: any[]): Generator<any, void, any>

dropwhile

  • dropwhile(iterable: any, predicate: any): Generator<any, void, unknown>
  • Drop from iterable until predicate is false

    Parameters

    • iterable: any
    • predicate: any

    Returns Generator<any, void, unknown>

enumerate

  • enumerate(iterable: any): Generator<any[], void, unknown>

filter

  • filter<T>(iter: Iterable<T>, predicate: function): Generator<T, void, unknown>
  • Type parameters

    • T

    Parameters

    • iter: Iterable<T>
    • predicate: function
        • (item: T): boolean
        • Parameters

          • item: T

          Returns boolean

    Returns Generator<T, void, unknown>

find

  • find<T>(iter: Iterable<T>, predicate: function): any
  • Type parameters

    • T

    Parameters

    • iter: Iterable<T>
    • predicate: function
        • (item: T): boolean
        • Parameters

          • item: T

          Returns boolean

    Returns any

head

  • head<T>(iterable: Iterable<T>): any

islice

  • islice(iterable: any, start: number, stop?: number): Generator<any, void, any>
  • islice(iter, stop) = Give the first stop elements islice(iter, start, stop) skip start elements, then give stop - start elements, unless stop is null, then emit indefinitely

    If the iterator runs out early so will this.

    Parameters

    • iterable: any
    • start: number
    • Optional stop: number

    Returns Generator<any, void, any>

iterEq

  • iterEq(...arrays: any[]): boolean

izip

  • izip(...arrays: any[]): Generator<any[], void, unknown>

map

  • map(arr: any, func: any): Generator<any, void, unknown>

permutationsWithReplacement

  • permutationsWithReplacement(arr: any, n: any): Generator<any[], void, unknown>
  • All permutations of n items from array

    Parameters

    • arr: any
    • n: any

    Returns Generator<any[], void, unknown>

range

  • range(length: any): Generator<number, void, unknown>

tail

  • tail<T>(iter: Iterable<T>): any
  • Get the last item of an array or iterable

    Type parameters

    • T

    Parameters

    • iter: Iterable<T>

    Returns any

takewhile

  • takewhile(iterable: any, predicate: any): Generator<any, void, unknown>
  • Take from iterable until predicate is false

    Parameters

    • iterable: any
    • predicate: any

    Returns Generator<any, void, unknown>

unique

  • unique(arr: any): any

uniqueBy

  • uniqueBy(arr: any, hasher: any): Generator<any, void, unknown>
  • Yield values that are unique under hasher(value)

    Parameters

    • arr: any
    • hasher: any

    Returns Generator<any, void, unknown>

zeros

  • zeros(n: any): any[]

zip

  • zip(...arrays: any[]): any[][]
  • Zip some arrays together

    If you need variable length args, you need izip for now.

    Parameters

    • Rest ...arrays: any[]

    Returns any[][]