Files
DefinitelyTyped/types/safe-timers/index.d.ts
Kamil Socha 6e560d4643 [safe-timers] Add definitions (#41454)
* Add safe-timers definitions

* Remove not public api, add comments
2020-01-07 15:30:12 -08:00

50 lines
1.6 KiB
TypeScript

// Type definitions for safe-timers 1.1
// Project: https://github.com/Wizcorp/safe-timers#readme
// Definitions by: Kamil Socha <https://github.com/ksocha>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.0
export const maxInterval: number;
export class Timeout {
/**
* Cancels timeout.
*/
clear(): void;
}
/**
* Creates and returns a `Timeout` instance that will call `callback` after at least `interval` milliseconds have passed.
* All arguments passed after the `interval` will be passed to the `callback` once it gets invoked.
*/
export function setTimeout<T extends any[]>(callback: (...args: T) => void, interval: number, ...args: T): Timeout;
/**
* Creates and returns a `Timeout` instance that will call `callback` when our clock reaches the given `timestamp` (in milliseconds).
* All arguments passed after the `timestamp` will be passed to the `callback` once it gets invoked.
*/
export function setTimeoutAt<T extends any[]>(callback: (...args: T) => void, timestamp: number, ...args: T): Timeout;
/**
* Cancels `timeout`.
*/
export function clearTimeout(timeout: Timeout): void;
export class Interval {
/**
* Cancels interval.
*/
clear(): void;
}
/**
* Creates and returns an `Interval` instance that will call `callback` after at least every `interval` milliseconds.
* All arguments passed after the `interval` will be passed to the `callback` when it gets invoked.
*/
export function setInterval<T extends any[]>(callback: (...args: T) => void, interval: number, ...args: T): Interval;
/**
* Cancels `interval`.
*/
export function clearInterval(interval: Interval): void;