UNPKG

1.44 kBTypeScriptView Raw
1import { AsyncIterableX } from './asynciterablex';
2/**
3 * Generates an async-iterable sequence by running a time-based state-driven loop producing the sequence's elements.
4 *
5 * @export
6 * @template TState The type of the state used in the generator loop.
7 * @template TResult The type of the elements in the produced sequence.
8 * @param {TState} initialState The initial state.
9 * @param {((value: TState, signal?: AbortSignal) => boolean | Promise<boolean>)} condition Condition to terminate generation (upon returning false).
10 * @param {((value: TState, signal?: AbortSignal) => TState | Promise<TState>)} iterate Iteration step function.
11 * @param {((value: TState, signal?: AbortSignal) => TResult | Promise<TResult>)} resultSelector Selector function for results produced in
12 * the sequence.
13 * @param {((value: TState, signal?: AbortSignal) => number | Promise<number>)} timeSelector Selector function for how much time to wait.
14 * @returns {AsyncIterableX<TResult>} The generated async-iterable sequence.
15 */
16export declare function generateTime<TState, TResult>(initialState: TState, condition: (value: TState, signal?: AbortSignal) => boolean | Promise<boolean>, iterate: (value: TState, signal?: AbortSignal) => TState | Promise<TState>, resultSelector: (value: TState, signal?: AbortSignal) => TResult | Promise<TResult>, timeSelector: (value: TState, signal?: AbortSignal) => number | Promise<number>): AsyncIterableX<TResult>;