# redux-persistence-engine-localstorage

> LocalStorage engine for redux-persistence

Latest version **1.0.0** (published 2019-08-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install redux-persistence-engine-localstorage
pnpm add redux-persistence-engine-localstorage
yarn add redux-persistence-engine-localstorage
bun add redux-persistence-engine-localstorage
```

## 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 |
| Published | 2019-08-06 |
| First published | 2019-08-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Decentraland |
| Maintainers | decentraland-bot |
| Keywords | decentraland, redux, redux-storage, persistence, local-storage |

## Links

- npm: https://www.npmjs.com/package/redux-persistence-engine-localstorage
- Repository: https://github.com/decentraland/redux-persistence-engine-localstorage
- Homepage: https://github.com/decentraland/redux-persistence-engine-localstorage#readme
- Issues: https://github.com/decentraland/redux-persistence-engine-localstorage/issues
- npm.io page: https://npm.io/package/redux-persistence-engine-localstorage

## Dependencies (4)

- [fp-future](https://npm.io/package/fp-future.md) ^1.0.1
- [@types/node](https://npm.io/package/@types/node.md) ^12.6.8
- [@types/sinon](https://npm.io/package/@types/sinon.md) ^7.0.13
- [redux-persistence](https://npm.io/package/redux-persistence.md) ^1.1.3

## 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

- 1.0.0 (latest) — 2019-08-06

## README

<h1 align="center" style="border-bottom: none;">redux-persistence-engine-localstorage</h1>
<h3 align="center">LocalStorage engine for redux-persistence</h3>

## Installation

    npm install --save redux-persistence-engine-localstorage

## Usage

Stores everything inside `window.localStorage`.

```js
import createEngine from 'redux-persistence-engine-localstorage'
const engine = createEngine('my-save-key')
```

You can customize the saving and loading process by providing a [`replacer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter) and/or a [`reviver`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Using_the_reviver_parameter).

```js
import createEngine from 'redux-storage-engine-localstorage';

function replacer (key, value) {
  if (typeof value === 'string') {
    return 'foo';
  }
  return value;
}

function reviver (key, value) {
  if (key === 'foo') {
    return 'bar';
  }
  return value;
});

const engine = createEngine('my-save-key', replacer, reviver);
```

**Warning**: `localStorage` does not expose a async API and every save/load
operation will block the JS thread!

**Warning**: This library only works on browsers that support Promises (IE11 or better)

**Warning**: If the browser doest not support LocalStorage, that should be handled before passing the engine to `redux-persistence` (see test)

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