@contentstack/advance-broadcast-message

Advanced Broadcast Message SDK

This repository contains an advanced broadcast message SDK that leverages the BroadcastChannel API to facilitate communication between different contexts (e.g., tabs, iframes) in a web application.

Table of Contents

• Installation
• Usage
• License

Installation

To install the dependencies, run:

npm install

Usage

To use the SDK, import the EventManager class and create an instance with a channel ID:

import { EventManager } from '@contentstack/advance-broadcast-message';

const eventManager = new EventManager('your-channel-id', {
    debug: false,
    suppressErrors: false
});

// Listen for events
eventManager.on('event-type', (payload) => {
    console.log('Received payload:', payload);
    return {
        status: 'received'
    }
});

// Send events
eventManager.send('event-type', { key: 'value' });

License

MIT License

Copyright © 2024 Contentstack. All Rights Reserved

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.