Function buffer

  • Creates a buffered asynchronous iterable from an input iterable with a specified time delay between elements.

    Returns

    A function that accepts an input iterable and returns a buffered asynchronous iterable with the specified delay.

    Example

    const input = [1, 2, 3];
    const bufferedIterable = buffer<number>(500)(input);

    (async () => {
    for await (const x of bufferedIterable) {
    console.log(x); // Logs 1, 2, 3 with a 500ms delay between each value
    }
    })();

    Type Parameters

    • T

      The type of elements in the input iterable.

    Parameters

    • ms: number

      The number of milliseconds to delay between elements.

    Returns ((input: AnyIterable<T>) => AsyncIterable<Awaited<T>>)

      • (input: AnyIterable<T>): AsyncIterable<Awaited<T>>
      • Parameters

        Returns AsyncIterable<Awaited<T>>

Generated using TypeDoc