@pubq/pubq-nodejs v4.1.2

PUBQ Node.js SDK

PUBQ is a pub/sub channels cloud and this is the official Node.js client library including both real-time and REST interfaces.

To meet PUBQ and see more info and examples, please read the documentation.

Getting Started

Follow these steps to just start building with PUBQ in Node.js or see the Quickstart guide which covers more programming languages.

Install with package manager

Use any package manager like npm or yarn to install the Node.js SDK.

Npm:

npm i @pubq/pubq-nodejs

Yarn:

yarn add @pubq/pubq-nodejs

Import as ES module:

import { Pubq } from "@pubq/pubq-nodejs";

Interacting with PUBQ

Get your application API key from PUBQ dashboard by creating a new app or use existing one.

Connect to PUBQ:

const realtime = new Pubq.RealTime({ key: "YOUR_API_KEY" });

Subscribe a channel:

let channel = realtime.subscribe("my-channel");

Listen for any data publish to receive:

(async () => {
    for await (let data of channel) {
        console.log({ data });
    }
})();

Publish a message:

realtime.publish("my-channel", "Hello!");

Publish a message with REST interface:

const rest = new Pubq.REST({ key: "YOUR_API_KEY" });

rest.publish("my-channel", "Hello!");

Development

Please, read the contribution guide.

Install

git clone git@github.com:pubqio/pubq-nodejs.git
cd ./pubq-nodejs/
npm i

Build

To build umd bundles, run:

npm run build