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

@cuban-engineer/redux-storage-middleware

v0.1.9

Published

Redux middleware for synchronizing store state with browser storages

Downloads

3

Readme

What makes the library better?

code style: prettier code linting: jest code quality: jest test coverage MIT license

Installation

Using npm:

npm i --save @cuban-engineer/redux-storage-middleware

Usage

If you are using ES modules:

import reduxStorageMiddleware from '@cuban-engineer/redux-storage-middleware';

Apply middleware to Redux:

import { applyMiddleware, createStore } from 'redux';
import reduxStorageMiddleware from '@cuban-engineer/redux-storage-middleware';
import rootReducer from './reducers/index';
 
const store = createStore(
  rootReducer,
  applyMiddleware(reduxStorageMiddleware)
);

Describe what needs to be saved in your Redux actions

For simple Redux states

Suppose you already have this simple action for changing the logged user token in your application for sending requests to an API.

export const changeUserToken = userToken =>
    ({
        type: 'CHANGE_USER_TOKEN',
        userToken
    });

Simply by adding the sync property which is an array of simple json objects that @cuban-engineer/redux-storage-middleware understands you can define what and where to save after the Reducer handle your action.

export const changeUserToken = userToken =>
    ({
        type: 'CHANGE_USER_TOKEN',
        userToken,
        sync: [
            {
                name: 'userToken',
                where: ['session', 'local'],
                hierarchy: ['user'],
            },
        ],
    });

Sync property Example

    sync: [
        {
            // Key in which will be saved the data in the Browser storage. 
            // If is not defined the key will be the @name attribute.
            key: 'token',
            // Literal name of the object in the Redux State that wants to be saved to the Browser storage.
            name: 'userToken',
            // Array of string enumerating where to save the data in the Browser storage.
            // Currently only Session and Local Storage. Cookies storage is coming son.
            // If only want to save in a single place is also possible to define it as a simple string, like this:
            // where: 'session'
            // If not defined, saving will occur in the Session Storage. 
            where: ['session', 'local'],
            // For more complex Stores, if using combineReducers for instance, the entire tree hierarchy for
            // obtaining the object in the State can be defined in the hierarchy attribute.
            // If only one level is needed to reach the desire object from the state, is also possible to define
            // the attribute as a simple string, like this hierarchy: 'ui'.
            // Example: state.user.userToken 
            hierarchy: ['user'],
        },
    ]

License

@cuban-engineer/redux-storage-middleware is MIT-licensed.