@rise/sdk-js-sockets v1.0.0-alpha.51

RiSE JavaScript/TypeScript SDK Sockets

This is the Default Sockets library for @rise/sdk-js

Installation

npm install @rise/sdk-js-sockets --save

Usage

Getting started

When initiating your RiSE instance, inject the sockets

// Create a new instance
import sockets from '@rise/sdk-js-sockets'
const rise = new RiSE({
  sandbox: true,
  public_key: <public_key>,
  private_key: <private_key>,
  sockets: sockets
})

// Authenticate for later requests by the API
rise.authenticateApiUser(
  <channel_uuid>,
  <adminIdentifier>,
  <adminPassword>
)
  .then(res => {
    <adminToken> = res.token
    adminSession = res.session
  })
  .catch(err => console.log)
})

Setup

Documentation

A quick start documentation, see the full documentation here.

Contributing

Release Instructions

When the master is tagged with a release, it will automatically publish to npm, updates the Changelog and bumps the version. The SDK uses the standard-version library to manage it all.

To run a patch release:

npm run release -- --release-as patch

and then commit to master. git push --follow-tags origin master

You can also test the release by running

npm run release -- --dry-run --release-as patch