Unissist NPM | npm.io

unissist

A tiny ~300b unistore persistence helper library state container with various storage adapters.

Install

This project uses node and npm. Go check them out if you don't have them locally installed.

npm install --save unissist

Then with a module bundler like webpack or rollup, use as you would anything else:

// The helper:
import persistStore from 'unissist';

// localStorage Adapter
import localStorageAdapter from 'unissist/integrations/localStorageAdapter';

// indexedDB Adapter
import indexedDBAdapter from 'unissist/integrations/indexdbAdapter';

// AsyncStorage Adapter
import asyncStorageAdapter from 'unissist/integrations/asyncStorageAdapter';

The UMD build is also available on unpkg:

<script src="//unpkg.com/unistore/dist/unissist.umd.js"></script>

You can find the library on window.unissist.

Usage

// use unistore like you always would, but use the unissist helper to persist state
import createStore from 'unistore'
import persistStore from 'unissist'
import localStorageAdapter from 'unissist/integrations/localStorageAdapter';

const store = createStore({ count: 0 })
const adapter = localStorageAdapter();

persistStore(store, adapter);

// store state now includes a `hydrated` that tells you whether or not the state has been rehydrated from the store

Unissist also takes a third parameter that allows you to configure how your peristence works

import createStore from 'unistore'
import persistStore from 'unissist'
import localStorageAdapter from 'unissist/integrations/localStorageAdapter';

const store = createStore({ count: 0 })
const adapter = localStorageAdapter();

// Default values except migration
let config = {
  version: 1,
  debounceTime: 100,
  // called when version is updated. Accepts promises. Defaults to dropping the store
  migration: (oldState, oldversion) => ({ /* new state */ }),
  // takes in the current state and returns the state to be persisted
  map: state => ({ /* new persisted state shape */ })
  // takes in state that will be hydrated and returns the new state shape
  hydration: state => ({ /* new state shape */ })
}

persistStore(store, adapter, config);

Reporting Issues

Found a problem? Want a new feature? First of all, see if your issue or idea has already been reported. If not, just open a new clear and descriptive issue.

Credits

Jason Miller for unistore, assign util function, and a lot of the tooling that I ~stole~ used Jake Archibald for idb-keyval where much of the code for the indexdbAdapter was ~stolen~ borrowed Sean Groff for the name