https://github.com/yoshuawuyts/choo-persist

Synchronize choo state with indexedDB
https://github.com/yoshuawuyts/choo-persist

Last synced: 20 days ago
JSON representation

Synchronize choo state with indexedDB

• Host: GitHub
• URL: https://github.com/yoshuawuyts/choo-persist
• Owner: yoshuawuyts
• License: mit
• Created: 2016-09-07T23:31:15.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-04-25T04:30:03.000Z (about 6 years ago)
• Last Synced: 2024-05-21T04:22:48.098Z (about 1 month ago)
• Language: JavaScript
• Size: 54.7 KB
• Stars: 44
• Watchers: 4
• Forks: 4
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-choo - choo-persist - Synchronize choo state with LocalStorage. (Uncategorized / Uncategorized)

README

        
# choo-persist [![stability][0]][1]

[![npm version][2]][3] [![build status][4]][5]

[![downloads][8]][9] [![js-standard-style][10]][11]

Persist [choo][choo] state to [localStorage][mdn]. localStorage is supported

by [all major browsers][caniuse].

## Usage

```js

var persist = require('choo-persist')

var choo = require('choo')

var app = choo()

app.use(persist())

```

## API

### `instance = persist([opts])`

Load the app state from `localStorage` and set up listeners to write the state

back on every event. Can take an optional argument of options:

- __opts.name:__ default `'choo-persist'`; the `localStorage` key.

- __opts.filter(state):__ modify the state that's about to be saved. Useful

  for removing values that cannot be serialized to JSON.

```js

var xtend = require('xtend')

var opts = {

  filter: function (state) {

    state = xtend(state) // clone the object

    delete state.sadArrayFilledWithFunctions

    return state

  }

}

```

## Installation

```sh

$ npm install choo-persist

```

## Should I use this while developing.

No; state is persisted between page reloads which might put your page in very

odd states, with a very annoying way to clear. Consider using hot reloading for

development instead.

## How / when should I invalidate the database cache?

Ah, this is where good ol' data persistance comes into play - there's loads of

approaches on this, but yeah you should def find a way to migrate data between

incompatible models. Perhaps some day we'll have a good chapter on this in the

choo handbook. Until then: have fun I guess?

## License

[MIT](https://tldrlegal.com/license/mit-license)

[0]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square

[1]: https://nodejs.org/api/documentation.html#documentation_stability_index

[2]: https://img.shields.io/npm/v/choo-persist.svg?style=flat-square

[3]: https://npmjs.org/package/choo-persist

[4]: https://img.shields.io/travis/yoshuawuyts/choo-persist/master.svg?style=flat-square

[5]: https://travis-ci.org/yoshuawuyts/choo-persist

[6]: https://img.shields.io/codecov/c/github/yoshuawuyts/choo-persist/master.svg?style=flat-square

[7]: https://codecov.io/github/yoshuawuyts/choo-persist

[8]: http://img.shields.io/npm/dm/choo-persist.svg?style=flat-square

[9]: https://npmjs.org/package/choo-persist

[10]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square

[11]: https://github.com/feross/standard

[caniuse]: http://caniuse.com/#feat=namevalue-storage

[mdn]: https://developer.mozilla.org/en-US/docs/Web/API/Storage/LocalStorage

[choo]: https://github.com/yoshuawuyts/choo