ixfx
    Preparing search index...

    Module @ixfx/iterables - v0.44.0

    Namespaces

    Async
    Chains
    Sync

    Functions

    asCallback

    Calls callback whenever the generator produces a value.

    chunks

    Breaks an iterable into array chunks

    computeAverage
    concat

    Return concatenation of iterators.

    dropWhile

    Drops elements that do not meet the predicate f. Streaming result: works with endless iterables.

    equals

    Returns true if items in two iterables are equal, as determined by the equality function. Order matters. It compares items at the same 'step' of each iterable.

    every

    Returns true if f returns true for every item in iterable.

    fill

    Yields v for each item within it.

    filter

    Filters an iterable, only yielding items which match f.

    find

    Returns first item from iterable it that matches predicate f

    flatten

    Returns a 'flattened' copy of array, un-nesting arrays one level. Streaming: works with unlimited iterables.

    forEach

    Execute function f for each item in iterable. If f returns false, iteration stops.

    fromArray

    Yield values from array, one at a time. Use interval to add time between each item. The first item is yielded without delay.

    fromEvent
    fromFunction

    Access callback as an iterable:

    fromFunctionAwaited

    Access awaited callback as an iterable:

    fromIterable

    Yield values from iterable, one at a time. Use interval to add time between each item. The first item is yielded without delay.

    hasEqualValuesShallow

    Returns true if all values in iterables are equal, regardless of their position. Uses === equality semantics by default.

    isAsyncIterable
    isIterable
    iteratorController

    Retrieve values from an iterator, passing them to a callback. Allows iterator to be started, paused, or restarted and an optional delay between reading items from iterator.

    last

    Returns the last item of an iterable, or undefined if it yields no results.

    map

    Maps an iterable through function f

    max

    Returns the maximum value of an iterable as it changes. Streaming result: works with endless iterables.

    maxScore

    Returns the 'max' of some iterable using the provided scoring function. It only yields a value when iterator finishes.

    min

    Returns a stream of minimum values.

    minScore

    Returns the 'min' of some iterable using the provided scoring function. It only yields a value when iterator finishes.

    numbersCompute

    Returns the min, max, avg and total of the array or iterable. Any values that are invalid are silently skipped over.

    reduce

    Reduce for iterables

    slice

    Returns a section from an iterable.

    some

    Returns true the first time f returns true. Useful for spotting any occurrence of data, and exiting quickly

    toArray

    Returns an array of values from an iterator.

    unique

    Returns unique items from an iterable or array of iterables.

    uniqueByValue

    Filters the input iterable, only yielding unique values. Use unique to compare by object reference instead.

    until

    Loops over a generator until it finishes, calling callback. Useful if you don't care about the value generator produces, just the number of loops.

    zip

    Combine same-positioned items from several iterables

    References

    combineLatestToArray → Chains.combineLatestToArray
    combineLatestToObject → Chains.combineLatestToObject

    Type Aliases

    ForEachOptions
    IteratorController
    IteratorControllerOptions
    IteratorControllerState
    ToArrayOptions
    WithEvents