Git Product home page Git Product logo

redux-normalizr-utils's Introduction

redux-normalizr-utils

Build Status: Linux Coverage Status

Motivation

When working with redux + normalizr to load data from server, developers have to write a LOT of boilerplate code.

Solution

A set of simple utilities to reduce boilerplate and allow developer concentrate on business logic.

Disclaimer

You might want to read this before you include any utils to your code.

This project was created for specific use case and might not fit your set up. Plenty of similar projects lurking out there in the wild. Try them out if this one does not cover your use case.

Usage

// Somewhere in ./reducers/index.js
import { combineReducers } from 'redux'
import { entityReducer } from 'redux-normalizr-utils'

import * as myReducers from './myReducers'

// Set-up reducer along with your own
export default combineReducers({
    ...myReducers,
    entities: entityReducer
});

Now any action that has entities key will be processed by reducer. Entities will be saved to store. It's expected that entities is produced by normalizr or have exactly same structure as normalizr would provide.

This way you can dispatch your actions, handle them with your reducers in order to e.g. set loading state, but entity storage will be managed automatically for you.

And this is how you clear entities, that are not needed anymore:

import { clearEntitiesAction } from 'redux-normalizr-utils'

const store = getStoreFromSomewhere();

// Kill all entities of schema 'nameOfSchema'
store.dispatch(clearEntitiesAction('nameOfSchema', true));

// Kill only one entity by it's name of schema and ID
store.dispatch(clearEntitiesAction('nameOfSchema', id));

// Kill several entities by schema name and ids array
store.dispatch(clearEntitiesAction('nameOfSchema', [id1, id2, id3]));

Include only what's needed

You can use only what you need and avoid including complete library. For example:

// Load only action
import { clearEntitiesAction } from 'redux-normalizr-utils/actions/entity'

// Load only reducer
import { entityReducer } from 'redux-normalizr-utils/reducers/entity'

redux-normalizr-utils's People

Contributors

andriichumak avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.