# rt-storage

> A real time storage library based on localforage and rxjs.

Latest version **0.1.0** (published 2019-10-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install rt-storage
pnpm add rt-storage
yarn add rt-storage
bun add rt-storage
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-10-30 |
| First published | 2019-04-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 150.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 11 |
| Maintainers | embbnux |
| Keywords | storage, realtime, multi-tabs, rxjs, localforage, javascript, library, typescript |

## Links

- npm: https://www.npmjs.com/package/rt-storage
- Repository: https://github.com/embbnux/rt-storage
- Homepage: https://github.com/embbnux/rt-storage#readme
- Issues: https://github.com/embbnux/rt-storage/issues
- npm.io page: https://npm.io/package/rt-storage

## Dependencies (3)

- [rxjs](https://npm.io/package/rxjs.md) ^6.4.0
- [uuid](https://npm.io/package/uuid.md) ^3.3.3
- [localforage](https://npm.io/package/localforage.md) ^1.7.3

## 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.1.0 (latest) — 2019-10-30
- 0.0.2 — 2019-04-22
- 0.0.1 — 2019-04-22

## README

# rt-storage

A real time storage library based on localforage and rxjs.

## Install

via npm:

```
npm install rt-storage
```

via yarn:

```
yarn add rt-storage
```

## Use

With Webpack:

```js
import RTStorage from 'rt-storage';

const storage = new RTStorage({ name: 'test-db' });
storage.subscribe((event) => {
  console.dir(event)
});
```

With CDN:

```html
<script src="https://unpkg.com/localforage@1.7.3/dist/localforage.js"></script>
<script src="https://unpkg.com/rxjs@6.4.0/bundles/rxjs.umd.min.js"></script>
<script src="https://wzrd.in/standalone/uuid%2Fv4@latest"></script>
<script src="https://unpkg.com/rt-storage@0.0.1/build/index.js"></script>
<script>
var storage = new RTStorage({ name: 'test-db' });
storage.subscribe((event) => {
  console.dir(event)
});
</script>
```

## API

### getItem

Get data from storage:

```js
storage.getItem(storageKey)
```

Return promise

### setItem

Set data into storage:

```js
storage.setItem(storageKey, data)
```

Return promise.

### subscribe

Subscribe storage data changed event:

```js
const subscription = storage.subscribe((event) => console.dir(event));
// subscription.unsubscribe
storage.subscribe('storageKey', (data) => console.dir(data));
```

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