choo-persist's Introduction

choo-persist

Persist choo state to localStorage. localStorage is supported by all major browsers.

Usage

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.

var xtend = require('xtend')
var opts = {
  filter: function (state) {
    state = xtend(state) // clone the object
    delete state.sadArrayFilledWithFunctions
    return state
  }
}

Installation

$ 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

choo-persist's People

Contributors

Stargazers

Watchers

choo-persist's Issues

Keep synced for connection losts

This is like a feature request. Right now, this plugin allow a fast first load from indexDB, cool. But what happens when the connections is lost, and the app attemp to make an http request. It would be awesome to allow to the user to keep using the app, and save all changes to local db, and once the connection is availaible again, repost all the state to keep data synced.
Well, the thing is that I'm actually facing this problem right now, I'm writing a pwa with choo here and is working for now, but when I go offline, I have a fast first load, thanks to sw and idb, but can go any other place in the app because of xhr calls failling.

Idea

I think this could be done using choo hooks. If there is a call for the onError hook due to xhr failing, save those changes only in the db, maybe an special collection only for offline diffs. Then on every state change, check if that special collection has data, in that case POST that data to sync the remote db, and clear that collection.

Well that sounds simple but I know is not haha. I wanna hear your opinion about it. Does it make sense? Do you have any better idea?

how to cache bust database

Perhaps upgrading DB versions using semver that's pulled in through brfs? idk how idb works haha

Saving state clones it twice

It looks like the onStateChange callback clones the new state twice (using xtend). Once on L48 and once on L79.

Synchronize choo state with indexedDB

Hi!
The repo description talks about indexedDB, but when I use choo-persist everything ends up in a big localStorage item.

Is there an option that I need to pass to choo-persist to say 'use indexedDB' or WebSQL etc, or even 'use localForage', rather than localStorage?

Recommend Projects

yoshuawuyts / choo-persist Goto Github PK