1.0.3 • Published 5 years ago

@kothman/pubsubts v1.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
5 years ago

PubSubTs

PubSub system written in TypeScript.

Contributing

Fork repository, install dependencies (i.e. yarn install). Build via yarn build, run tests (make sure to build first) via yarn test

Reference

Install via yarn add @kothman/pubsubts or npm install @kothman/pubsubts.

In your code:

import PubSub from 'pubsubts'
// also valid, but without TypeScript typings
const PubSub = require('pubsubts')

PubSub.on(eventName: string, handler: Function): number

returns reference number, used for PubSub.off

PubSub.once(eventName: string, handler: Function): number

Same as PubSub.on, except ref is removed (via PubSub.off(eventName, ref)) after being called

PubSub.off(eventName: string, ref?: number)

Removes specific handler. If ref not provided, removes all handlers for eventName.

PubSub.emit(eventName: string, data: any)

Calls all registered handlers (with data if provided) for eventName