# local-observable-store

> An observable data-store that persists in local storage

Latest version **0.0.3** (published 2015-09-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install local-observable-store
pnpm add local-observable-store
yarn add local-observable-store
bun add local-observable-store
```

## 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.0.3 |
| Published | 2015-09-13 |
| First published | 2014-04-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Olivier Scherrer |
| Maintainers | podefr |
| Keywords | observable, store, local, localstorage, storage, localstore, persist |

## Links

- npm: https://www.npmjs.com/package/local-observable-store
- Repository: https://github.com/cosmosio/local-observable-store
- Issues: https://github.com/cosmosio/local-observable-store/issues
- npm.io page: https://npm.io/package/local-observable-store

## Dependencies (2)

- [simple-loop](https://npm.io/package/simple-loop.md) 0.0.2
- [observable-store](https://npm.io/package/observable-store.md) 0.0.5

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2015-09-13
- 0.0.2 — 2014-04-09
- 0.0.1 — 2014-04-09

## README

Local Observable Store
=============

An observable data-store that persists in local storage. It's a subtype of [observable-store](https://github.com/flams/observable-store), which means that it can be used just like the `observable-store` but also adds persistance in `localStorage`.

Installation
============

```bash
npm install local-observable-store
```

How to use
==========

Require and initialize local-observable-store:

```js
var LocalStore = require("local-observable-store"),
  localStore = new LocalStore();
```

Synchronize the local-observable-store with an already saved store in localStorage:

```js
localStore.sync("persistedStore");
```

If there's anything currently in localStorage, it will be loaded in the store:

```js
localStorage.setItem("persistedStore", JSON.stringify({ property: "value" }));

localStore = new LocalStore();
localStore.sync("peristedStore");

localStore.get("property"); // value
```

Then, everytime something changes in the local-observable-store, it's automatically persisted in localStorage.

```js
localStore.set("newProperty", "hello!");

JSON.parse(localStorage.getItem("persistedStore")).newProperty; // "hello!";
```

CHANGELOG
=========

### 0.0.3 - 13 SEP 2015

* Update to latest observable-store
* Update license field in package.json


LICENSE
=======

MIT

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