Skip to content

EventEmitter

Publish-subscribe class.

Class

Methods

MethodParametersDescriptionDefault
onSubscribe to eventSubscribe to event, pass event name and callbackNone
onceSubscribe to event onceSubscribe to event once, trigger once then auto unsubscribeNone
offUnsubscribe from eventUnsubscribe from event, pass event name and callbackNone
emitTrigger eventTrigger event, requires event nameNone

Example

js
import { Subscribe } from 'ranuts';

const subscribe = new Subscribe();

// Subscribe to event 1
subscribe.on('event', () => {
  console.log(1);
});
// Subscribe to event 2
subscribe.on('event', () => {
  console.log(2);
});
// Subscribe to event 3
const eventThree = () => {
  console.log(3);
};
subscribe.on('event', eventThree);
// Subscribe to event 4, need to pass parameters
subscribe.on('event', (num) => {
  console.log(num);
});
// Trigger event, pass parameters
subscribe.emit('event', 4);
// console.log(1) console.log(2) console.log(3) console.log(4)

// Unsubscribe event three
subscribe.off('event', eventThree);

// Subscribe once, auto unsubscribe after trigger
subscribe.once('other', () => {
  console.log(5);
});

Released under the MIT License.