pubbel v5.1.2

Pubbel

Pubbel is a light-weight JavaScript library around event-driven elements that can be used in front-end applications. It offers different usages for a publish-subscribe implemementation (wrapped as an event emitter), and an asynchronous queue that emits events.

Event Emitter

An event emitter can be created by using the emitter function.

import { emitter } from 'pubbel';
const _emitter = emitter();

You subscribe to a topic by using the on(topic: string, callback: Function) function. The callbacks can either be synchronous or asynchronous (NOTE: topic '*' is a wildcard topic that triggers on every emit).

function myFunction(...args) { ... }
_emitter.on('message-1', myFunction);
_emitter.off('message-1', myFunction);

Publishing a message on your emitter can be done by using the emit(topic, ...args) function.

_emitter.emit('message-2', data);

Broadcast channel

The broadcast channel can be used to synhronize data between browser tabs of running web applications. Synchronization is done via the localStorage (due to browser support). However, no data persists in the localStorage. As input, it requires a name and an optional configuration object. The available functions are the same as for the event emitter.

import { channel } from 'pubbel';

const myChannel = channel('my-channel');
myChannel.on('message-1', myCallback);
myChannel.emit('message-1', data);

Store

import { store } from 'pubbel';

const myStore = store({});
myStore.mutate('key', 1);
console.log(myStore.get('key')); // 1
console.log(myStore.get('key', (v) => v * 2)); // 2

myChannel.on('key', myCallback); // called on mutate