broadcast-channel

What is broadcast-channel?

The broadcast-channel npm package allows different browser tabs, iframes, web workers, and node.js processes to communicate with each other. It uses various methods like IndexedDB, local storage, or native events to create a channel that can be used to broadcast messages across different contexts running on the same machine.

What are broadcast-channel's main functionalities?

Creating a Broadcast Channel

This code sample demonstrates how to import the BroadcastChannel class from the package and create a new channel named 'my-channel'.

const { BroadcastChannel } = require('broadcast-channel');
const channel = new BroadcastChannel('my-channel');

Sending a Message

This code sample shows how to send a message ('Hello World') through the channel to other listening contexts.

channel.postMessage('Hello World');

Receiving Messages

This code sample sets up an event listener to receive messages sent to the channel and logs them to the console.

channel.onmessage = (message) => console.log('Received:', message);

Closing a Channel

This code sample demonstrates how to close the channel when it is no longer needed to free up resources.

channel.close();

Other packages similar to broadcast-channel

pubsub-js

PubSubJS is a topic-based publish/subscribe library that's similar to broadcast-channel but does not support communication between different browser tabs or node processes.

localforage

While primarily a local storage library, localForage can be used to store and retrieve messages across sessions, which can be a form of communication similar to broadcast-channel, but it's not designed specifically for message broadcasting.

README

BroadcastChannel

A BroadcastChannel that works in old browsers, new browsers, WebWorkers and NodeJs
+ LeaderElection over the channels

---

A BroadcastChannel allows simple communication between browsing contexts with the same origin or different NodeJs processes.

This implementation works with old browsers, new browsers, WebWorkers and NodeJs. You can use it to send messages between multiple browser-tabs, iframes, WebWorkers and NodeJs-processes.

This behaves similar to the BroadcastChannel-API which is currently not featured in all browsers.

Using the BroadcastChannel

This API behaves similar to the javascript-standard.

npm install --save broadcast-channel

Create a channel in one tab/process and send a message.

const BroadcastChannel = require('broadcast-channel');
const channel = new BroadcastChannel('foobar');
channel.postMessage('I am not alone');

Create a channel with the same name in another tab/process and recieve messages.

const BroadcastChannel = require('broadcast-channel');
const channel = new BroadcastChannel('foobar');
channel.onmessage = msg => console.dir(msg);
// > 'I am not alone'

Add and remove multiple eventlisteners

const BroadcastChannel = require('broadcast-channel');
const channel = new BroadcastChannel('foobar');

const handler = msg => console.log(msg);
channel.addEventListener('message', handler);

// remove it
channel.removeEventListener('message', handler);

Close the channel if you do not need it anymore.

channel.close();

Set options when creating a channel (optional):

const options = {
    type: 'localstorage', // (optional) enforce a type, oneOf['native', 'idb', 'localstorage', 'node']
    webWorkerSupport: true; // (optional) set this to false if you know that your channel will never be used in a WebWorker (increases performance)
};
const channel = new BroadcastChannel('foobar', options);

Create a typed channel in typescript:

import BroadcastChannel from 'broadcast-channel';
declare type Message = {
  foo: string;
};
const channel: BroadcastChannel<Message> = new BroadcastChannel('foobar');
channel.postMessage({
  foo: 'bar'
});

Methods:

Depending in which environment this is used, a proper method is automatically selected to ensure it always works.

Method	Used in	Description
Native	Modern Browsers	If the browser supports the BroadcastChannel-API, this method will be used because it is the fastest
IndexedDB	Browsers with WebWorkers	If there is no native BroadcastChannel support, the IndexedDB method is used because it supports messaging between browser-tabs, iframes and WebWorkers
LocalStorage	Older Browsers	In older browsers that do not support IndexedDb, a localstorage-method is used
Sockets	NodeJs	In NodeJs the communication is handled by sockets that send each other messages

Using the LeaderElection

This module also comes with a leader-election which can be used so elect a leader between different BroadcastChannels. For example if you have a stable connection from the frontend to your server, you can use the LeaderElection to save server-side performance by only connecting once, even if the user has opened your website in multiple tabs.

Create a channel and an elector.

const BroadcastChannel = require('broadcast-channel');
const LeaderElection = require('leader-election');
const channel = new BroadcastChannel('foobar');
const elector = LeaderElection.create(channel);

Wait until the elector becomes leader.

const LeaderElection = require('leader-election');
const elector = LeaderElection.create(channel);
elector.awaitLeadership().then(()=> {
  console.log('this tab is now leader');
})

Let the leader die. (automatically happens if the tab is closed or the process exits).

const elector = LeaderElection.create(channel);
await elector.die();

What this is

This module is optimised for:

• low latency: When you postMessage on one channel, it should take as low as possible time until other channels recieve the message.
• lossless: When you send a message, it should be impossible that the message is lost before other channels recieved it
• low idle workload: During the time when no messages are send, there should be a low processor footprint.

What this is not

• This is not a polyfill. Do not set this module to window.BroadcastChannel. This implementation behaves similiar to the BroadcastChannel-Standard with these limitations:
  • You can only send data that can be JSON.stringify-ed.
  • While the offical API emits onmessage-events, this module directly emitts the data which was posted
• This is not a replacement for a message queue. If you use this in NodeJs and want send more than 50 messages per second, you should use proper IPC-Tooling

Browser Support

I have tested this in all browsers that I could find. For ie8 and ie9 you must transpile the code before you can use this. If you want to know if this works with your browser, open the demo page.

Thanks

Thanks to Hemanth.HM for the module name.