# rapid-io

> JavaScript SDK for Rapid.io to be used both server-side and client-side.

Latest version **0.4.2** (published 2017-07-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install rapid-io
pnpm add rapid-io
yarn add rapid-io
bun add rapid-io
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.2 |
| Published | 2017-07-29 |
| First published | 2017-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | prichodko |
| Keywords | websocket, realtime, realtime-database |

## Links

- npm: https://www.npmjs.com/package/rapid-io
- Repository: https://github.com/rapid-io/rapid-io-javascript
- Homepage: https://www.rapid.io
- Issues: https://github.com/rapid-io/rapid-io-javascript/issues
- npm.io page: https://npm.io/package/rapid-io

## Dependencies (8)

- [ws](https://npm.io/package/ws.md) ^3.0.0
- [backo](https://npm.io/package/backo.md) ^1.1.0
- [debug](https://npm.io/package/debug.md) ^2.6.8
- [base-64](https://npm.io/package/base-64.md) ^0.1.0
- [shortid](https://npm.io/package/shortid.md) ^2.2.8
- [sort-keys](https://npm.io/package/sort-keys.md) ^2.0.0
- [component-emitter](https://npm.io/package/component-emitter.md) ^1.2.1
- [@rapid-io/protocol](https://npm.io/package/@rapid-io/protocol.md) ^0.0.72

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.4.2 (latest) — 2017-07-29
- 0.4.1 — 2017-07-25
- 0.4.0 — 2017-07-23
- 0.3.2 — 2017-06-16
- 0.3.1 — 2017-06-14
- 0.3.0 — 2017-06-14
- 0.2.1 — 2017-06-07
- 0.2.0 — 2017-06-07
- 0.1.2 — 2017-06-06

## README

<p align="center">
  <img alt="logo" src="https://raw.githubusercontent.com/rapid-io/javascript/dev/logo.png" />
</p>
<hr/>


<p align="center">
  <strong>JavaScript client for <a href="https://rapid.io">Rapid.io</a> realtime database</strong>
</p>
<h3 align="center">
	<a href="https://rapid.io">
	  Website
	</a>
	<span> | </span>
	<a href="https://rapid.io/docs">
	  Documentation
	</a>
	<span> | </span>
	<a href="https://rapid.io/docs/api-reference-javascript">
	  Reference
	</a>
</h3>

[![Build Status](https://travis-ci.org/rapid-io/javascript.svg?branch=master)](https://travis-ci.org/rapid-io/javascript)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

# What
Rapid.io is a cloud-hosted service that allows app developers to build realtime user interfaces without having to worry about the underlying infrastructure. It works as a non-relational data store accessible from a client-side code. 

# Why
Clients can create, update, delete and subscribe to a set of data and receive updates in realtime.

# How
To include a library you can either use a npm package manager or include it directly trough a `<script>` tag.

### Node.js / webpack / Browserify / Rollup
If you need a library for a server-side usage or you are using a module bundler, you can install it from npm:

```shell
yarn add rapid-io
```
```shell
npm install --save rapid-io

```
Then include the library:
```js
import rapid from 'rapid-io' // ES6 modules
```
```js
const rapid = require('rapid-io') // RequireJS
```
And use it: 
```js
const client = rapid.createClient(API_KEY)
```


### Browser
Alternatively you can use a standalone UMD build for browsers. You can use fast and global [unpkg](https://unpkg.com/#/) CDN.
```html
<script src=" https://unpkg.com/rapid-io/dist/rapid-io.umd.js"></script>
<script>
	const client = Rapid.createClient(API_KEY)
</script>
```

See [Getting Started](https://rapid.io/docs/getting-started) for more information.

## Caught a bug? 
Open an issue.

## License
[The MIT License](https://github.com/rapid-io/javascript/blob/dev/license)

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