@amandaghassaei/event-dispatcher
Advanced tools
Parent class to support custom event listeners, written in TypeScript.
Parent class to support custom event listeners.
Table of Contents:
npm install @amandaghassaei/event-dispatcher
Then import via:
import { EventDispatcherPrototype } from '@amandaghassaei/event-dispatcher';
OR in the browser you can add event-dispatcher.js or event-dispatcher.min.js to your html:
<html>
<head>
....
<script src="event-dispatcher.min.js"></script>
</head>
<body>
</body>
</html>
Then in your js files, you can access the global variable EVENT_DISPATCHER:
const { EventDispatcherPrototype } = EVENT_DISPATCHER;
See full API documentation in docs/.
import {
EventDispatcherPrototype,
EventListener,
} from '@amandaghassaei/event-dispatcher';
// Define events and class event types.
const THING_A_CHANGE_EVENT = 'THING_A_CHANGE_EVENT';
const THING_A_FINISHED_EVENT = 'THING_A_FINISHED_EVENT';
const THING_A_REMOVED_EVENT = 'THING_A_REMOVED_EVENT';
type ThingAEventType =
typeof THING_A_CHANGE_EVENT |
typeof THING_A_FINISHED_EVENT |
typeof THING_A_REMOVED_EVENT;
const THING_B_CHANGE_EVENT = 'THING_B_CHANGE_EVENT';
const THING_B_FINISHED_EVENT = 'THING_B_FINISHED_EVENT';
const THING_B_REMOVED_EVENT = 'THING_B_REMOVED_EVENT';
type ThingBEventType =
typeof THING_B_CHANGE_EVENT |
typeof THING_B_FINISHED_EVENT |
typeof THING_B_REMOVED_EVENT;
// Create a custom EventDispatcher subclass.
// Use function overloads to define correct typing of subclass event/listener pairs.
// Event listeners may accept an optional parameter.
class EventDispatcher<T> extends EventDispatcherPrototype<T> {
addOneTimeEventListener(type: typeof THING_A_REMOVED_EVENT, listener: () => void): void;
addOneTimeEventListener(type: typeof THING_B_REMOVED_EVENT, listener: () => void): void;
addOneTimeEventListener(type: any, listener: EventListener) {
this._prototype_addOneTimeEventListener(type, listener);
}
addEventListener(type: typeof THING_A_CHANGE_EVENT, listener: (object: ThingA) => void): void;
addEventListener(type: typeof THING_A_FINISHED_EVENT, listener: (object: ThingA) => void): void;
addEventListener(type: typeof THING_B_CHANGE_EVENT, listener: (object: ThingB) => void): void;
addEventListener(type: typeof THING_B_FINISHED_EVENT, listener: (object: ThingB) => void): void;
addEventListener(type: any, listener: EventListener) {
this._prototype_addEventListener(type, listener);
}
removeEventListener(type: typeof THING_A_CHANGE_EVENT, listener: (object: ThingA) => void): void;
removeEventListener(type: typeof THING_A_FINISHED_EVENT, listener: (object: ThingA) => void): void;
removeEventListener(type: typeof THING_B_CHANGE_EVENT, listener: (object: ThingB) => void): void;
removeEventListener(type: typeof THING_B_FINISHED_EVENT, listener: (object: ThingB) => void): void;
removeEventListener(type: any, listener: EventListener) {
this._prototype_removeEventListener(type, listener);
}
// You may decide to make dispatchEvent a protected function,
// which can only be called from within the subclass.
protected dispatchEvent(type: typeof THING_A_CHANGE_EVENT, object: ThingA): void;
protected dispatchEvent(type: typeof THING_A_FINISHED_EVENT, object: ThingA): void;
protected dispatchEvent(type: typeof THING_B_CHANGE_EVENT, object: ThingB): void;
protected dispatchEvent(type: typeof THING_B_FINISHED_EVENT, object: ThingB): void;
protected dispatchEvent(type: typeof THING_A_REMOVED_EVENT): void;
protected dispatchEvent(type: typeof THING_B_REMOVED_EVENT): void;
protected dispatchEvent(type: any, object?: any) {
this._prototype_dispatchEvent(type, object);
}
}
// Define your EventListener subclasses.
class ThingA extends EventDispatcher<ThingAEventType>{
...
}
class ThingB extends EventDispatcher<ThingBEventType>{
...
}
This work is distributed under an MIT license. It has no dependencies.
Inspired by Three.js's EventDispatcher class.
Install dev-dependencies:
npm install
Build from src to dist and compile docs:
npm run build
Test with code coverage:
npm run test-with-coverage
FAQs
Parent class to support custom event listeners, written in TypeScript.
The npm package @amandaghassaei/event-dispatcher receives a total of 8 weekly downloads. As such, @amandaghassaei/event-dispatcher popularity was classified as not popular.
We found that @amandaghassaei/event-dispatcher demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
The Socket Threat Research Team uncovered a coordinated campaign that floods the Chrome Web Store with 131 rebranded clones of a WhatsApp Web automation extension to spam Brazilian users.
Security News
ENISA’s 2025 Threat Landscape report highlights how AI is reshaping cyber attacks, driving phishing, model poisoning, and software supply chain risks.
Security News
Evan You announces Vite+, a commercial, Rust-powered toolchain built on the Vite ecosystem to unify JavaScript development and fund open source.