Skip to content
redux-starter-kit createSlice helpers for common reducer types.
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
.gitignore
.npmignore
.travis.yml
README.md
index.test.ts
index.ts
jest.config.js
package.json
prettier.config.js
prettier.md.js
tests.js
tsconfig.json
tslint.json
type-tests.ts
yarn.lock

README.md

slice-helpers Build Status

redux-starter-kit createSlice helpers for common reducer types.

My philosophy when building a redux app is to have fat effects, skinny reducers. Most of the logic of the app should live inside of effects (e.g. thunks, sagas) because it is a central location to manage business rules. When reducers start listening to actions outside of their own domain, it becomes difficult to understand what happens when an action gets dispatched. Instead of going to one function to see the coordinated changes of our state, we now have to grep and find every reference to that action type and then read each file to observe what is happening. When we think of reducers as simple storage containers that do not contain any meaningful business logic, a set of very common reducers emerge: map, assign, and loader. These three reducer types handle 90% of my reducers in any given react/redux app.

This library created those reducer types so we can focus on business logic instead of reducer boilerplate.

Features

  • Built on top of redux-starter-kit createSlice
  • Dramatically reduces boilerplate for action/reducer creation
  • Simply reducers with a set of common operations

Requirements

  • redux-starter-kit >= 1.0 is a peer dependency

Install

yarn add slice-helpers

Usage

map slice

These are common operations when dealing with a slice that is a hash map.

params: { name, initialState?, extraReducers? }

import { mapSlice } from 'slice-helpers';

interface SliceState {
  [key: string]: { name: string, email: string };
}

const name = 'test';
const { reducer, actions } = mapSlice<SliceState>({ name });
const state = {
  3: { name: 'three', email: 'three@three.com' }
};

store.dispatch(
  actions.add({
    1: { name: 'one', email: 'one@one.com' },
    2: { name: 'two', email: 'two@two.com' },
  })
);
/* {
  1: { name: 'one', email: 'one@one.com' },
  2: { name: 'two', email: 'two@two.com' },
  3: { name: 'three', email: 'three@three.com' },
} */

store.dispatch(
  actions.set({
    4: { name: 'four', email: 'four@four.com' },
    5: { name: 'five', email: 'five@five.com' },
    6: { name: 'six': email: 'six@six.com' },
  })
)
/* {
  4: { name: 'four', email: 'four@four.com' },
  5: { name: 'five', email: 'five@five.com' },
  6: { name: 'six': email: 'six@six.com' },
} */

store.dispatch(
  actions.remove(['5', '6'])
)
/* {
  4: { name: 'four', email: 'four@four.com' },
} */

// only update a part of the entity
store.dispatch(
  actions.patch({
    4: { name: 'five' }
  })
)
/* {
  4: { name: 'five', email: 'four@four.com' },
} */

store.dispatch(
  actions.reset()
)
// {}

assign slice

These are common operations when dealing with a slice that simply needs to be set or reset

params: { name, initialState, extraReducers? }

import { assignSlice } from 'slice-helpers';

type SliceState = string;

const name = 'token';
const { reducer, actions } =
  assignSlice < SliceState > { name, initialState: '' };

store.dispatch(actions.set('some-token'));
/* redux state: { token: 'some-token' } */

store.dispatch(actions.set('another-token'));
/* redux state: { token: 'another-token' } */

store.dispatch(actions.reset());
// redux state: { token: '' }

loading slice

Helper slice that will handle loading data

params: { name, extraReducers? }

import { loadingSlice } from 'slice-helpers';

const { actions, reducer } = loadingSlice({ name: 'loading' });
store.dispatch(actions.loading('something loading'));
// redux state: { loading: { error: '', message: 'something loading', loading: true, success: false } }

store.dispatch(actions.success('great success'));
// redux state: { loading: { error: '', message: 'great success', loading: false, success: true } }

store.dispatch(actions.error('something happened'));
// redux state: { loading: { error: 'something happened', loading: false, success: false } }

Test

yarn test

Build

yarn build
You can’t perform that action at this time.