npm

npm’s 2019 JavaScript ecosystem survey analysis is now available! Get your copy here »

redux-preboiled

0.1.0 • Public • Published

Redux Preboiled

npm Build Status

Documentation

Redux Preboiled is a collection of general-purpose Redux helper functions. It helps you reduce boilerplate when writing reducers, action creators, and tests.

  • Served à la carte. Each of Preboiled's helpers can be used stand-alone. Just pick and use the ones you want and ignore the rest. If your build setup does tree shaking, the unused helpers won't even be added to your application's build output.

  • Minimal magic. Preboiled avoids clever "magic" tricks which minimize boilerplate at the expense of understandability. Instead, it favors simple, composable functions with easy-to-understand semantics and implementations.

  • TypeScript-friendly. Redux Preboiled is written in TypeScript. Its helpers are designed to be easy to type and amenable to automatic type inference, making it easy to write type-safe Redux code.

Installation

# NPM 
npm install redux-preboiled
 
# Yarn 
yarn add redux-preboiled

A First Taste

The following snippet uses a bunch of Redux Preboiled's helpers to define a simple Redux counter module with support for increment and multiply actions. It is about half the size of the equivalent vanilla Redux code.

import {
  chainReducers,
  createAction,
  onAction,
  withInitialState
} from 'redux-preboiled'
 
const increment = createAction('increment')
const multiply = createAction('multiply').withPayload()
 
const counterReducer = chainReducers(
  withInitialState(0),
  onAction(increment, state => state + 1),
  onAction(multiply, (state, action) => state * action.payload)
)
 
// Example usage:
 
import { createStore } from 'redux'
 
const store = createStore(counterReducer)
store.dispatch(increment())
store.dispatch(increment())
store.dispatch(multiply(2))
store.getState()
// => 4
  • createAction generates various types of action creator functions with minimal ceremony. The specified action type value is made available as an action creator property (increment.type and mutliply.type in this example), making separate action type constants unnecessary. See the Actions guide.

  • The onAction, withInitialState and chainReducers helpers can be combined as a less noisy alternative to the classic switch reducer pattern. In TypeScript, the type of the sub-reducers' action parameters are automatically inferred from the action creators passed to onAction, improving type safety and editor auto-completion. See the Reducers guide.

Documentation

See the guides for a tour through Preboiled, or jump right to the API docs for detailed descriptions of all helpers Redux Preboiled has to offer.

Keywords

none

install

npm i redux-preboiled

Downloadsweekly downloads

14

version

0.1.0

license

MIT

last publish

collaborators

  • avatar
Report a vulnerability