@podium/browser
TypeScript icon, indicating that this package has built-in type declarations

1.2.3 • Public • Published

@podium/browser

This is a client-side library designed to send and receive messages between different podlets in a layout.

Usage

To install:

npm install @podium/browser

Include the library in your client-side application.

import Podium from '@podium/browser';

Send messages between podlets

Use the MessageBus to send messages between podlets in a layout.

// In podlet A. Broadcast a message.
import { MessageBus } from '@podium/browser';

const messageBus = new MessageBus();

messageBus.publish('search', 'query', 'couch');
// In podlet B. Subscribe to a message.
import { MessageBus } from '@podium/browser';

const messageBus = new MessageBus();

messageBus.subscribe('search', 'query', (event) => {
    console.log(event.payload);
});

API

MessageBus

Cross podlet communication and message passing. Create a new MessageBus instance to use the API.

import { MessageBus } from '@podium/browser';

const messageBus = new MessageBus();

.publish(channel, topic, payload)

Publish a message for a channel and topic combination. Returns the Event object passed to subscribers.

This method takes the following arguments:

option default type required details
channel null string true Name of the channel
topic null string true Name of the topic
payload null any false The payload for the event

Examples:

messageBus.publish('search', 'query', 'laptop');

messageBus.publish('auth', 'logout');

.subscribe(channel, topic, callback)

Subscribe to messages for a channel and topic combination.

This method takes the following arguments:

option default type required details
channel null string true Name of the channel
topic null string true Name of the topic
callback null Function true Callback function to be invoked. Receives an event object

Example:

messageBus.subscribe('channel', 'topic', (event) => {
    console.log(event.payload);
});

.unsubscribe(channel, topic, callback)

Unsubscribe to events for a channel and topic combination.

This method takes the following arguments:

option default type required details
channel null string true Name of the channel
topic null string true Name of the topic
callback null Function true Callback function to remove.

Example:

function cb(event) {
    console.log(event.payload);
}

messageBus.subscribe('channel', 'topic', cb);

messageBus.unsubscribe('channel', 'topic', cb);

.peek(channel, topic)

Get the latest event for a channel and topic combination.

This method takes the following arguments:

option default type required details
channel null string true Name of the channel
topic null string true Name of the topic

.log(channel, topic)

Returns an array of the 10 latest events for a channel and topic combination. The array is ordered such that the the latest/newest events is at the front of the array.

This method takes the following arguments:

option default type required details
channel null string true Name of the channel
topic null string true Name of the topic

Example:

const events = messageBus.log('channel', 'topic');

events.forEach((event) => {
    console.log(event.payload);
});

Package Sidebar

Install

npm i @podium/browser

Weekly Downloads

776

Version

1.2.3

License

MIT

Unpacked Size

40.7 kB

Total Files

25

Last publish

Collaborators

  • trygve-lie
  • digitalsadhu
  • ivarconr
  • alexanbj
  • stipsan
  • trygve-bot