remix-utils-rt
Version:
This package contains simple utility functions to use with [React Router](https://reactrouter.com/home).
19 lines (18 loc) • 661 B
TypeScript
interface Options {
signal?: AbortSignal;
}
/**
* Get an async iterable that yields on an interval until aborted.
* @param ms The amount of time to wait between intervals, in milliseconds
* @param options The options for the timer
* @returns An async iterable that yields on each intervals
* @example
* let controller = new AbortController();
* for await (let _ of interval(1000, { signal: controller.signal })) {
* // Do something every second until aborted
* }
*/
export declare function interval(ms: number, options?: Options): AsyncGenerator<undefined, void, unknown>;
export declare class TimersError extends globalThis.Error {
}
export {};