triggerbus
TypeScript icon, indicating that this package has built-in type declarations

4.0.0 • Public • Published

🚌 triggerbus

Build Status npm MIT license Maintainability Test Coverage

Simple Typescript eventbus that uses trigger to broadcast events. Works in any environment.

import triggerbus from 'triggerbus'
 
const bus = triggerbus()
 
bus.on('event', console.log)
bus.trigger('event', { foo: 42 })
// => log('event', { foo: 42 })

Installation

yarn add triggerbus
npm install triggerbus --save

Usage

import triggerbus from 'triggerbus'
 
const bus = triggerbus()
 
const off1 = bus.on('name', callback)
// => off1() unregisters callback from name
//    alternatively: bus.off('name', callback)
 
const off2 = bus.once('name', callback)
// => off2() unregisters callback from name
//    automatically unregisters after calling callback once
 
bus.off('name')
// => removes all listeners of name
 
bus.off('name', callback)
// => removes first listener that matches callback
//    does *not* remove "once" listener
 
bus.trigger('name', { foo: 42 })
// => triggers all listeners on 'name' and '*' with ('name', { foo: 42 })

Package Sidebar

Install

npm i triggerbus

Weekly Downloads

15

Version

4.0.0

License

MIT

Unpacked Size

148 kB

Total Files

90

Last publish

Collaborators

  • sleeplessbyte