Examples

Arbiter: A Simple Event System

Arbiter is a straightforward event system designed to facilitate communication between different parts of your application, particularly for inter-module communication. It enables efficient data exchange among modules, contributing to a more organized and modular codebase.

Here's a concise code example demonstrating how to use Arbiter:

JAVASCRIPT

import Arbiter from 'bigpipe-util/dist/core/Arbiter';

// Create an instance of Arbiter
const arbiter1 = new Arbiter();

// Subscribe to an event with a callback function
const subscription = arbiter1.subscribe("ORDER/READY", (order) => {
    console.warn(order);
});

// To unsubscribe, use one of the following methods:
// 1. Remove the subscription
// subscription.remove();

// 2. Unsubscribe a specific callback function
// arbiter1.unsubscribe("ORDER/READY", callbackFunction);

// 3. Clear all subscribers for a specific event
// arbiter1.clearSubscribers("ORDER/READY");

// Simulate an event trigger after a delay
setTimeout(() => {
    const arbiter2 = new Arbiter();

    // Trigger an event with data
    arbiter2.inform("ORDER/READY", {
        orderId: 12300,
        customer: "John Doe",
        total: 100.99,
    });
}, 1000);

An event that happens once, like "the user is logged in", can be informed with informState() instead. A callback subscribed later is then called right away with the last data:

JAVASCRIPT

new Arbiter().informState("USER/LOGGED_IN", user);

// Later, e.g. in a module loaded afterwards
new Arbiter().subscribe("USER/LOGGED_IN", (user) => greet(user)); // called right away

Live Example

Independent widgets that react to one event informed from PHP, and one added later that gets the last state, in the demo page.

Edit this page on GitHub