@types/d3-timer

What is @types/d3-timer?

@types/d3-timer provides TypeScript type definitions for the d3-timer module, which is part of the D3.js library. The d3-timer module provides a simple timer mechanism for scheduling tasks to run at a specified time or interval, making it useful for animations, periodic updates, and other time-based operations.

What are @types/d3-timer's main functionalities?

Creating a Timer

This feature allows you to create a timer that calls a specified callback function repeatedly until the timer is stopped. The callback receives the elapsed time since the timer started.

import { timer } from 'd3-timer';

const t = timer((elapsed) => {
  console.log(`Elapsed time: ${elapsed}ms`);
  if (elapsed > 1000) t.stop();
});

Stopping a Timer

This feature allows you to stop a running timer either from within the callback function or from an external function.

import { timer } from 'd3-timer';

const t = timer((elapsed) => {
  console.log(`Elapsed time: ${elapsed}ms`);
  if (elapsed > 1000) t.stop();
});

// Stop the timer after 500ms
setTimeout(() => t.stop(), 500);

Creating an Interval

This feature allows you to create an interval that calls a specified callback function at a fixed time interval. The callback receives the elapsed time since the interval started.

import { interval } from 'd3-timer';

const i = interval((elapsed) => {
  console.log(`Elapsed time: ${elapsed}ms`);
  if (elapsed > 5000) i.stop();
}, 1000);

Creating a Timeout

This feature allows you to create a timeout that calls a specified callback function once after a specified delay. The callback receives the elapsed time since the timeout was scheduled.

import { timeout } from 'd3-timer';

timeout((elapsed) => {
  console.log(`Elapsed time: ${elapsed}ms`);
}, 2000);

Other packages similar to @types/d3-timer

setInterval

The built-in JavaScript setInterval function provides similar functionality for running a callback function at a specified interval. However, it lacks the precision and control offered by d3-timer, such as the ability to receive the elapsed time and the ease of stopping the timer.

setTimeout

The built-in JavaScript setTimeout function provides similar functionality for running a callback function once after a specified delay. Like setInterval, it lacks the precision and control offered by d3-timer.

README

Installation

npm install --save @types/d3-timer

Summary

This package contains type definitions for d3-timer (https://github.com/d3/d3-timer/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/d3-timer/v2.

Additional Details

• Last updated: Wed, 18 Oct 2023 00:05:18 GMT
• Dependencies: none

Credits

These definitions were written by Tom Wanzek, Alex Ford, Boris Yankov, denisname, and Nathan Bierema.