@toruslabs/secure-pub-sub

secure-pub-sub

Introduction

This repo allow you to publish and subscribe to a single message in a topic

Features

• Typescript compatible. Includes Type definitions
• All API's return Promises

Installation

Bundling

This module is distributed in 3 formats

• ems build dist/securePubSub.esm.js in es5 format
• commonjs build dist/securePubSub.cjs.js in es5 format with problematic packages bundled (benfits non-webpack users)
• umd build dist/securePubSub.umd.min.js in es5 format without polyfilling corejs minified

By default, the appropriate format is used for your specified usecase You can use a different format (if you know what you're doing) by referencing the correct file

The cjs build is not polyfilled with core-js. It is upto the user to polyfill based on the browserlist they target

Directly in Browser

CDN's serve the non-core-js polyfilled version by default. You can use a different

jsdeliver

<script src="https://cdn.jsdelivr.net/npm/@toruslabs/secure-pub-sub"></script>

unpkg

<script src="https://unpkg.com/@toruslabs/secure-pub-sub"></script>

Tips for NUXT

This is a plugin that works only on the client side. So please register it as a ssr-free plugin.

Usage

Add @toruslabs/secure-pub-sub to your project:

To allow your web app to retrieve keys:

Install the package npm i @toruslabs/secure-pub-sub or yarn add @toruslabs/secure-pub-sub

Requirements

• This package requires a peer dependency of @babel/runtime
• Node 18+