mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
8ae97451d5
* [d3-collection] Linted * Added and completed linting * Replaced `Object` with `any` adding TODO to change to proper `object` type when publishing the definitions to use TS 2.2+ * [d3-color] Linted * [d3-dispatch] Linted * [d3-hsv] Linted * [d3-interpolate] Linted. `Object` to `any` * Replace use of `Object` as extension basis with `any` for now. Added TODO to change it to use the `object` type, when updating the definitions to formally use TS2.2+ * [d3-path] Linted. * [d3-polygon] Linted. * [d3-quadtree] Linted. * [d3-queue] Linted. * [d3-request] Linted. * [d3-scale-chromatic] Linted. * [d3-time-format] Linted. * [d3-time] Linted. * [d3-timer] Linted. * [d3-voronoi] Linted. * [d3-scale] Move callable-type lint deactivation to tslint.json * line level deactivation was ignored.
74 lines
3.8 KiB
TypeScript
74 lines
3.8 KiB
TypeScript
// Type definitions for d3JS d3-timer module 1.0
|
|
// Project: https://github.com/d3/d3-timer/
|
|
// Definitions by: Tom Wanzek <https://github.com/tomwanzek>, Alex Ford <https://github.com/gustavderdrache>, Boris Yankov <https://github.com/borisyankov>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
// Last module patch version validated against: 1.0.2
|
|
|
|
/**
|
|
* Returns the current time as defined by performance.now if available, and Date.now if not.
|
|
* The current time is updated at the start of a frame; it is thus consistent during the frame, and any timers scheduled during the same frame will be synchronized.
|
|
* If this method is called outside of a frame, such as in response to a user event, the current time is calculated and then fixed until the next frame,
|
|
* again ensuring consistent timing during event handling.
|
|
*/
|
|
export function now(): number;
|
|
|
|
export interface Timer {
|
|
/**
|
|
* Restart a timer with the specified callback and optional delay and time.
|
|
* This is equivalent to stopping this timer and creating a new timer with the specified arguments,
|
|
* although this timer retains the original invocation priority.
|
|
*
|
|
* @param callback A callback function to be invoked and passed in the apparent
|
|
* elapsed time since the timer became active in milliseconds.
|
|
* @param delay An optional numeric delay in milliseconds (default = 0) relative to time.
|
|
* @param time An optional time in milliseconds relative to which the delay is calculated (default = now).
|
|
*/
|
|
restart(callbackFn: (elapsed: number) => void, delay?: number, time?: number): void;
|
|
|
|
/**
|
|
* Stop the timer.
|
|
*/
|
|
stop(): void;
|
|
}
|
|
|
|
/**
|
|
* Schedules and returns a new timer, invoking the specified callback repeatedly until the timer is stopped.
|
|
* The callback is passed the (apparent) elapsed time since the timer became active.
|
|
*
|
|
* @param callback A callback function to be invoked and passed in the apparent
|
|
* elapsed time since the timer became active in milliseconds.
|
|
* @param delay An optional numeric delay in milliseconds (default = 0) relative to time.
|
|
* @param time An optional time in milliseconds relative to which the delay is calculated (default = now).
|
|
*/
|
|
export function timer(callback: (elapsed: number) => void, delay?: number, time?: number): Timer;
|
|
|
|
/**
|
|
* Immediately invoke any eligible timer callbacks
|
|
*/
|
|
export function timerFlush(): void;
|
|
|
|
/**
|
|
* Schedules and returns a new timer, invoking the specified callback. The timer is stopped automatically
|
|
* on its first callback. The callback is passed the (apparent) elapsed time since the timer became active.
|
|
*
|
|
* @param callback A callback function to be invoked and passed in the apparent
|
|
* elapsed time since the timer became active in milliseconds.
|
|
* @param delay An optional numeric delay in milliseconds (default = 0) relative to time.
|
|
* @param time An optional time in milliseconds relative to which the delay is calculated (default = now).
|
|
*/
|
|
export function timeout(callback: (elapsed: number) => void, delay?: number, time?: number): Timer;
|
|
|
|
/**
|
|
* Schedules and returns a new timer, invoking the specified callback repeatedly every 'delay' milliseconds
|
|
* until the timer is stopped.
|
|
* The callback is passed the (apparent) elapsed time since the timer became active.
|
|
*
|
|
* @param callback A callback function to be invoked and passed in the apparent
|
|
* elapsed time since the timer became active in milliseconds.
|
|
* @param delay An optional numeric delay in milliseconds between repeat invocations of the callback.
|
|
* If not specified, the interval timer behaves like the regular timer.
|
|
* @param time An optional time in milliseconds relative to which the initial delay is calculated (default = now).
|
|
*/
|
|
export function interval(callback: (elapsed: number) => void, delay?: number, time?: number): Timer;
|