Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
mwc-browser
Advanced tools
Readme
Manager-Workers communication between browser tabs.
✅ No dependencies
✅ Browser support
✅ Manager-Workers communication
✅ Can be used also for just messaging between tabs
npm i mwc-browser
Create channel connection with mwcBrowser
.
import { mwcBrowser } from 'mwc-browser';
const channelConnection = mwcBrowser<string>('my-channel-name');
Create channel connection with Channel
constructor.
import { Channel } from 'mwc-browser';
const channelConnection = new Channel<string>('my-channel-name');
You can also pass optional options
.
import { mwcBrowser } from 'mwc-browser';
const channelConnection = mwcBrowser<string>('my-channel-name', {
pingTimer: 500, // The iterable time to make ping.
zombiesTimer: 500, // The iterable time to search for zombie channel connections.
managerTimer: 1000, // The iterable time to look for channel connection to be manager if possible.
maxLife: 3000, // The max life time to decide if channel connection is zombie if not responded.
isEmitMessageToSelf: false, // If you want to get the message you sent to your self from onMessage event.
});
Channel connection properties
.
import { mwcBrowser } from 'mwc-browser';
const channelConnection = mwcBrowser<string>('my-channel-name');
channelConnection.id; // Channel connection UUID.
channelConnection.isManager; // If Channel connection is Manager.
channelConnection.numberOfConnections; // The number of current channel connections that connected to the same channel.
Send message to other channel connections or to your self.
import { mwcBrowser } from 'mwc-browser';
const channelConnection = mwcBrowser<string>('my-channel-name');
channelConnection.emitMessage('hi all :)');
Listen to channel connection events
.
import { mwcBrowser } from 'mwc-browser';
const channelConnection = mwcBrowser<string>('my-channel-name');
channelConnection.onManager = (isManager: boolean): void => {
// Do something by if you are manager or not...
};
channelConnection.onMessage = (message: string): void => {
// Do something with the message...
};
Remove the channel connection if you don't need it anymore.
import { mwcBrowser } from 'mwc-browser';
const channelConnection = mwcBrowser<string>('my-channel-name');
// ...
channelConnection.destroy(); // Will cancel intervals, event listeners, etc.
FAQs
Manager-Workers communication between browser tabs
The npm package mwc-browser receives a total of 0 weekly downloads. As such, mwc-browser popularity was classified as not popular.
We found that mwc-browser demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.