npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@superbalist/js-pubsub

v3.0.0

Published

A JS abstraction for the pub-sub pattern

Downloads

648

Readme

@superbalist/js-pubsub

A JS abstraction for the pub-sub pattern

Author Build Status Software License NPM Version NPM Downloads

Installation

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:

Usage

"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 interface.

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 for all adapters and a 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:

$ node examples/LocalExample.js