UNPKG

timeout-flow

Version:

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

37 lines (36 loc) 1.06 kB
/** * Schedules a one-time delayed function. * * Preferred: * - after(fn, duration, [options]) * * Also supported (legacy/alt): * - after(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 {Function} [c.onFinish] - Optional callback after `fn` runs * @param {AbortSignal} [c.signal] - Optional AbortSignal to auto-cancel * @returns {{ * pause(): void, * resume(): void, * cancel(): void, * reset(): void, * readonly isRunning: boolean, * readonly isPaused: boolean, * readonly isFinished: boolean * }} */ export function after(a: Function | string | number, b: Function | string | number | Object, c?: { onFinish?: Function | undefined; signal?: AbortSignal | undefined; }): { pause(): void; resume(): void; cancel(): void; reset(): void; readonly isRunning: boolean; readonly isPaused: boolean; readonly isFinished: boolean; };