little-pubsub

Small publish & subscribe class

INSTALL

npm

1npm i --save @crabas0npm/nihil-fuga-aut

USAGE

1import PubSub from '@crabas0npm/nihil-fuga-aut'
2const pubsub = new PubSub()

Example

1import PubSub from '@crabas0npm/nihil-fuga-aut'
2const pubsub = new PubSub()
3
4pubsub.subscribe('event', (value) => {
5  console.log(value)
6})
7
8pubsub.publish('event', 'hello')
9// always runs handler
10// (can use to overide littlePubsub.verbose setting without changing the behavior of the rest)
11pubsub.publishVerbose('event', 'hello')
12
13pubsub.unsubscribe('event', (value) => {
14  console.log(value)
15})
16
17pubsub.hasSubscribers('event')
18
19await pubsub.once('event')

API

pubsub([options])

verbose: when false only fires after value change

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

subscribe

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

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

unsubscribe

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

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

publish

name: name of the channel to publish to
handler: method
verbose: boolean

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

publish

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

1pubsub.publishVerbose('event-name', 'data')

once

name: name of the channel to publish to

1await pubsub.once('event-name')

hasSubscribers

name: name of the channel to publish to

1pubsub.hasSubscribers('event-name')