# @rise/sdk-js-sockets

> Node SDK Sockets for RiSE

Latest version **1.0.0-alpha.51** (published 2020-01-13) · 0 weekly downloads

## Install

```sh
npm install @rise/sdk-js-sockets
pnpm add @rise/sdk-js-sockets
yarn add @rise/sdk-js-sockets
bun add @rise/sdk-js-sockets
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-alpha.51 |
| Published | 2020-01-13 |
| First published | 2020-01-13 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 7.6.0 |
| Dependencies | 9 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | scott-wyatt |
| Maintainers | scottbwyatt |

## Links

- npm: https://www.npmjs.com/package/@rise/sdk-js-sockets
- npm.io page: https://npm.io/package/@rise/sdk-js-sockets

## Dependencies (9)

- [qs](https://npm.io/package/qs.md) ^6.9.1
- [joi](https://npm.io/package/joi.md) ^14.3.1
- [primus](https://npm.io/package/primus.md) ^7.3.3
- [request](https://npm.io/package/request.md) ^2.88.0
- [engine.io](https://npm.io/package/engine.io.md) ^3.4.0
- [@fabrix/regexdot](https://npm.io/package/@fabrix/regexdot.md) ^1.0.1
- [engine.io-client](https://npm.io/package/engine.io-client.md) ^3.4.0
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [request-promise-native](https://npm.io/package/request-promise-native.md) ^1.0.7

## Recent versions

- 1.0.0-alpha.51 (latest) — 2020-01-13

## README

![RiSE Logo][logo]

# RiSE JavaScript/TypeScript SDK Sockets

[![NPM version][npm-image]][npm-url]
[![Build Status][ci-image]][ci-url]
[![Dependency Status][daviddm-image]][daviddm-url]

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

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

```js
// 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](https://www.npmjs.com/package/standard-version) to manage it all.

To run a patch release: 
```bash
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
```bash
npm run release -- --dry-run --release-as patch
``` 
 
[logo]: https://rise.store/wp-content/uploads/2019/06/rise_sized_75x150_blk-01-01-01.png "RiSE"
[npm-image]: https://img.shields.io/npm/v/@rise/sdk-js-sockets.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@rise/sdk-js-sockets
[ci-image]: https://img.shields.io/circleci/project/github/rise-app/rise-sdk-js-sockets/master.svg
[ci-url]: https://circleci.com/gh/rise-app/rise-sdk-js-sockets/tree/master
[daviddm-image]: http://img.shields.io/david/rise-app/rise-sdk-js-sockets.svg?style=flat-square
[daviddm-url]: https://david-dm.org/rise-app/rise-sdk-js-sockets
[coverage-image]: https://img.shields.io/codeclimate/coverage/github/rise-app/rise-sdk-js-sockets.svg?style=flat-square
[coverage-url]: https://codeclimate.com/github/rise-app/rise-sdk-js-sockets/coverage

---
_Source: https://npm.io/package/@rise/sdk-js-sockets · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._