psmq v0.2.1

About

PubSubMQ is a message queue system that implements the publish/subscribe pattern. It provide the ability for a message producer to push any type of payload to any number of message consumers in a synchronous fashion. (An async implementation is forthcoming)

It is ready to be used in both web browser and Node/server-side environments. It can be leveraged for example to create reactive UI elements.

Installation

Via NPM:

npm i psmq

or git clone this repository.

Usage

Importing the module:

import { MessageQueue } from "psmq"; // In a Node environment

// OR

import { MessageQueue } from "./psmq/index.js"; // Import from index.js in non-Node environments

Creating and using a message queue instance:

const mq = new MessageQueue();

// Register a "message consumer" in the form of a callback argument to the `subscribe` method,
// which returns a `Subscription` object.
const subscription1 = mq.subscribe(message => console.log("From consumer 1:", message));
const subscription2 = mq.subscribe(message => console.log("From consumer 2:", message));

// Publish some messages
mq.publish(123);
mq.publish("hello world");
// OUTPUT
// From consumer 1: 123
// From consumer 2: 123
// From consumer 1: hello world
// From consumer 2: hello world

// Call the `unsubscibe` method on the `Subscription` object to stop its associated "message consumer"
// to receive further messages. It is important to call `unsubscribe` when further message updates
// are no longer necessary so as to avoid memory leaks.
subscription1.unsubscribe();

mq.publish("some more news");
// OUTPUT
// From consumer 2: some more news

subscription2.unsubscribe();
mq.publish("anyone here?");
// NO OUTPUT

Notes

• This package is fully annotated and supports IntelliSense.
• Suggestions and contributions are welcome.