timeout-flow/types/every.d.ts

Fluent, composable, pauseable JavaScript timers and time control flows — plus RAF utilities for frame-based logic.

/**
 * Runs a function every N ms with optional execution limit.
 *
 * Preferred:
 * - every(fn, duration, [options])
 *
 * Also supported (legacy/alt):
 * - every(duration, fn, [options])
 *
 * @param {Function|string|number} a - Function or duration (see overloads)
 * @param {Function|string|number|Object} b - Duration, function, or options
 * @param {Object} [c] - Options
 * @param {number} [c.max=Infinity] - Max times to run
 * @param {boolean} [c.runImmediately=false] - Run immediately on first tick
 * @param {AbortSignal} [c.signal] - Optional AbortSignal to auto-cancel
 * @returns {{
*   pause(): void,
*   resume(): void,
*   cancel(): void,
*   reset(restart?: boolean): void,
*   readonly isRunning: boolean,
*   readonly isPaused: boolean,
*   readonly isFinished: boolean,
*   readonly count: number
* }}
*/
export function every(a: Function | string | number, b: Function | string | number | Object, c?: {
    max?: number | undefined;
    runImmediately?: boolean | undefined;
    signal?: AbortSignal | undefined;
}): {
    pause(): void;
    resume(): void;
    cancel(): void;
    reset(restart?: boolean): void;
    readonly isRunning: boolean;
    readonly isPaused: boolean;
    readonly isFinished: boolean;
    readonly count: number;
};