@types/d3-dispatch

What is @types/d3-dispatch?

The @types/d3-dispatch package provides TypeScript type definitions for the d3-dispatch package, which is part of the D3 (Data-Driven Documents) JavaScript library. This package helps in managing and dispatching custom events in complex applications. It is particularly useful when integrating D3 with TypeScript projects, as it ensures type safety and enhances code readability and maintainability.

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

Creating a dispatch

This code demonstrates how to create a dispatcher with custom event types: 'load', 'progress', and 'error'. It allows you to register and trigger these events in your application.

import { dispatch } from 'd3-dispatch';

const dispatcher = dispatch('load', 'progress', 'error');

Registering event listeners

This code shows how to register different event listeners for the events created in the dispatcher. Each event type has a corresponding function that will be called when that event is dispatched.

dispatcher.on('load', loadData);
dispatcher.on('progress', updateProgress);
dispatcher.on('error', handleError);

Dispatching events

This code illustrates how to dispatch the 'load' and 'progress' events with associated data. The 'load' event is dispatched with a URL, and the 'progress' event with a numeric value representing progress.

dispatcher.call('load', this, { url: 'http://example.com/data' });
dispatcher.call('progress', this, 50);

Other packages similar to @types/d3-dispatch

mitt

Mitt is a tiny functional event emitter/listener library. It offers similar event handling capabilities but is more general-purpose compared to @types/d3-dispatch, which is specifically tailored for D3 applications.

eventemitter3

EventEmitter3 is a high-performance event emitter. While providing similar functionalities, it is optimized for performance and is not specific to any library, unlike @types/d3-dispatch which is designed to work with D3.

README

Installation

npm install --save @types/d3-dispatch

Summary

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

Details

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

Additional Details

• Last updated: Fri, 22 Sep 2023 20:29:40 GMT
• Dependencies: none
• Global values: none

Credits

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