Events

@servie/events"">
@servie/events"">


@servie/events"">

Tiny type-safe event emitter.

Installation

npm install @servie/events --save

Usage

import { Emitter, once, ALL_EVENTS } from "@servie/events";
// Define an events interface using keys & argument tuples.
interface Events {
  test: [boolean];
  other: [string];
}
// Initialize an `Emitter` using your `Events` interface.
const events = new Emitter<Events>();
// Add or remove listeners.
const listener = (...args) => console.log(args);
const off = events.on("test", listener);
// Emit an event.
events.emit("test", true);
// Listen to _all_ events, i.e. for debugging.
const eachListener = ({ type, args }) => console.log(type, args);
const off = events.on(ALL_EVENTS, eachListener);
// "Once" utility.
const runOnce = (...args) => console.log(args);
once(events, "test", runOnce);
// Remove the listener.
off();

TypeScript

This project is written using TypeScript and publishes the definitions directly to NPM.

License

MIT