little-pubsub v1.2.0

little-pubsub

Small publish & subscribe class

INSTALL

npm

npm i --save little-pubsub

USAGE

import PubSub from 'little-pubsub';
const pubsub = new PubSub();

Example

import PubSub from 'little-pubsub';
const pubsub = new PubSub();

pubsub.subscribe('event', value => { console.log(value) })

pubsub.publish('event', 'hello')

pubsub.unsubscribe('event', value => { console.log(value) })

PubSub.isLittlePubSub(pubsub)

API

pubsub(options)

verbose: when false only fires after value change

pubsub = new PubSub({
  verbose: false // default: true
})

subscribe

name: name of the channel to subscribe to handler: method context: context

pubsub.subscribe('event-name', data => {
  console.log(data);
})

unsubscribe

name: name of the channel to unsubscribe handler: method context: context

pubsub.unsubscribe('event-name', data => {
  console.log(data);
})

publish

name: name of the channel to publish to handler: method context: context

pubsub.publish('event-name', 'data')

isLittlePubSub

instance: instance to check

const LittlePubSub = require('little-pubsub')
const pubsub = new LittlePubSub()

LittlePubSub.isLittlePubSub(pubsub)