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

pubq

v1.0.19

Published

PUBQ JavaScript SDK

Downloads

12

Readme

PUBQ JavaScript SDK

PUBQ is a pub/sub channels cloud and this is the official JavaScript 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 JavaScript 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 JavaScript SDK.

Npm:

npm i pubq

Yarn:

yarn add pubq

Import as ES module:

import { Pubq } from "pubq";

Import from CDN:

<script src="https://cdn.jsdelivr.net/npm/pubq@latest/build/browser/pubq.min.js"></script>

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 to a channel and listen for any data publishing to receive:

let channel = realtime.channels.get("my-channel");
channel.subscribe((message: any) => {
    console.log({ message });
});

Publish a message:

channel.publish("Hello!");

Publish a message with REST interface:

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

let channel = rest.channels.get("my-channel");

channel.publish("Hello!");

Development

Please, read the contribution guide.

Install

git clone [email protected]:pubqio/pubq-js.git
cd ./pubq-js/
npm i

Build

To build umd bundles, run:

npm run build