es-stl - v3.0.2
    Preparing search index...

    Interface IterateCallback<V, K>

    Callback invoked while traversing an iterator owner.

    Returning false stops iterator forEach traversal early. Other iterator helpers define their own stop conditions by passing a different break flag.

    const collectUntilThree: IterateCallback<number, number> = (value) => {
    return value < 3;
    };

    Type Parameters

    • V

      Iterated value type.

    • K

      Iterated key type.

    • Handles one iterated value.

      Parameters

      • v: V

        Current value.

      • k: K

        Current key.

      • i: number

        Zero-based iteration index.

      • length: number

        Total number of values in the traversal.

      Returns boolean | void

      Returning false can stop forEach traversal early.