npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

redux-persistent

v4.0.0

Published

Redux middleware for persisting and hydrating state

Downloads

64

Readme

redux-persistent

Build Status npm package Coverage Status

Meant as an alternative to redux-persist, providing a selector based API, while remaining compatible with its persistors ecosystem.

Install

Install the package using:

# npm package
$ npm install --save redux-persistent

Usage

Simple demo:

import { createStore, applyMiddleware } from 'redux';
import persistent, { hydrate } from 'redux-persistent';
import { setUsername } from './actions';

const store = createStore(reducer, initialState, applyMiddleware(
  persistent({
    username: { // persists the result of getUsername(state) inside the provided storage, under the keye 'username'
      selector: getUsername,
      load: (username, ({ dispatch })) => dispatch(setUsername(username)),
    },
  }, {
    storage: localStorage, // optional, defaults to localStorage, also tested with redux-persist-node-storage
  }),
))

store.dispatch(hydrate());

This module relies on ES6 Symbol, so it needs to be polyfilled in environments where it is not supported. For example:

import 'core-js/features/symbol';

Or if using rollup, you can use rollup-plugin-polyfill.

API

persist

The default export of this module, and the redux middleware. Accepts the following arguments:

selectors

Type: Object, required

Key-value pair. The key will be used to store the item inside the provided storage, while the value is an object with the shape { selector: (state) => any, load: (value, store) => void }. The selector defines the value to store, and load defines how to restore the value into the redux store.

const selectors = {
  [key]: {
    selector: (state: Object) => any, // serializable
    load: (value: any, { dispatch, getState }) => void,
  },
};

options

options.storage

A redux-persist compatible storage. It is an object of the shape:

const storage = {
  getItem: (key: String) => Promise<any> | any,
  setItem: (key: String, value: any) => Promise<void> | void,
  removeItem: (key: String) => Promise<void> | void,
};

By default, const storage = localStorage.

hydrate

An action creater to load the stored state into the redux store.

remove

An action creator to remove a stored item from the provided storage.

License

See the LICENSE file for license rights and limitations (MIT).