@reactivex/ix-es5-esm/asynciterable/generatetime.d.ts

The Interactive Extensions for JavaScript

import { AsyncIterableX } from './asynciterablex.js';
/**
 * Generates an async-iterable sequence by running a time-based state-driven loop producing the sequence's elements.
 *
 * @template TState The type of the state used in the generator loop.
 * @template TResult The type of the elements in the produced sequence.
 * @param {TState} initialState The initial state.
 * @param {((value: TState, signal?: AbortSignal) => boolean | Promise<boolean>)} condition Condition to terminate generation (upon returning false).
 * @param {((value: TState, signal?: AbortSignal) => TState | Promise<TState>)} iterate Iteration step function.
 * @param {((value: TState, signal?: AbortSignal) => TResult | Promise<TResult>)} resultSelector Selector function for results produced in
 * the sequence.
 * @param {((value: TState, signal?: AbortSignal) => number | Promise<number>)} timeSelector Selector function for how much time to wait.
 * @returns {AsyncIterableX<TResult>} The generated async-iterable sequence.
 */
export 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>;