Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/superbalist/js-pubsub
A JS abstraction for the pub-sub pattern
https://github.com/superbalist/js-pubsub
javascript js-pubsub node node-js node-module nodejs nodejs-modules pubsub superbalist
Last synced: about 3 hours ago
JSON representation
A JS abstraction for the pub-sub pattern
- Host: GitHub
- URL: https://github.com/superbalist/js-pubsub
- Owner: Superbalist
- License: mit
- Created: 2017-05-02T06:29:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-06-07T09:33:28.000Z (over 2 years ago)
- Last Synced: 2024-10-29T16:02:38.057Z (8 days ago)
- Topics: javascript, js-pubsub, node, node-js, node-module, nodejs, nodejs-modules, pubsub, superbalist
- Language: JavaScript
- Size: 63.5 KB
- Stars: 3
- Watchers: 35
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# @superbalist/js-pubsub
A JS abstraction for the pub-sub pattern
[](https://twitter.com/superbalist)
[](https://travis-ci.org/Superbalist/js-pubsub)
[](LICENSE)
[](https://www.npmjs.com/package/@superbalist/js-pubsub)
[](https://www.npmjs.com/package/@superbalist/js-pubsub)
## Installation
```bash
npm install @superbalist/js-pubsub
```
## Adapters
* Local (bundled)
* /dev/null (bundled)
* Redis - https://github.com/Superbalist/js-pubsub-redis
* Google Cloud - https://github.com/Superbalist/js-pubsub-google-cloud
* HTTP - https://github.com/Superbalist/js-pubsub-http
## Integrations
Want to get started quickly? Check out some of these integrations:
* [js-pubsub-manager](https://github.com/Superbalist/js-pubsub-manager) - A factory and manager with multi adapter support.
## Usage
```node
"use strict";
let LocalPubSubAdapter = require('@superbalist/js-pubsub').LocalPubSubAdapter;
let adapter = new LocalPubSubAdapter();
// consume messages
adapter.subscribe('my_channel', (message) => {
console.log('channel: my_channel');
console.log(message);
});
// publish messages
adapter.publish('my_channel', 'Hello World!');
// publish multiple messages
let messages = [
'message 1',
'message 2',
];
adapter.publishBatch('my_channel', messages);
```
## Writing an Adapter
You can easily write your own custom adapter by implementing the [PubSubAdapterInterface](src/PubSubAdapterInterface.js) interface.
```node
class CustomAdapter {
/**
* Subscribe a handler to a channel.
*
* @param {string} channel
* @param {subscriberCallback} handler - The callback to run when a message is received
* @example
* adapter.subscribe('my_channel', (message) => {
* console.log(message);
* });
*/
subscribe(channel, handler) {
}
/**
* Publish a message to a channel.
*
* @param {string} channel
* @param {*} message - The message payload
* @return {Promise<*>}
* @example
* // publish a string
* adapter.publish('my_channel', 'Hello World');
*
* // publish an object
* adapter.publish('my_channel', {
* 'id': 1234,
* 'first_name': 'Matthew',
* });
*/
publish(channel, message) {
}
/**
* Publish multiple messages to a channel.
*
* @param {string} channel
* @param {*[]} messages
* @return {Promise<*>}
* @example
* let messages = [
* 'message 1',
* 'message 2',
* ];
* adapter.publishBatch('my_channel', messages);
*/
publishBatch(channel, messages) {
}
}
```
## Examples
The library comes with [examples](examples) for all adapters and a [Dockerfile](Dockerfile) for
running the example scripts.
Run `make up`.
You will start at a `bash` prompt in the `/usr/src/app` directory.
If you need another shell to publish a message to a blocking consumer, you can run `docker-compose run js-pubsub /bin/bash`
To run the examples:
```bash
$ node examples/LocalExample.js
```