@americanexpress/vitruvius
v3.0.1
Published
Add buildInitialState method to your reducers
Downloads
228
Readme
vitruvius
Vitruvius extends redux's combineReducers
to allow developers to include a
buildInitialState
method on their reducer. This allows for the passing of
locals to build the initial state that wouldn't normally be available to a
reducer when setting its initial state. For instance, one could pass some data
from the request object.
Want to get paid for your contributions to
vitruvius
? Send your resume to [email protected]
Installation
$ npm install --save @americanexpress/vitruvius
Implementation
Below is an example of a reducer implementing a buildInitialState
method and
an example of vitruvius being implemented.
import { Map } from 'immutable';
export const SOME_ACTION = 'SOME_ACTION';
const buildInitialState = ({ data } = {}) => new Map({ foo: data || 'bar' });
export default function reducer(state = buildInitialState(), action) {
switch (action.type) {
case SOME_ACTION:
return state.set('foo', action.data);
default:
return state;
}
}
reducer.buildInitialState = buildInitialState;
TIP: To extend
combineReducers
fromredux-immutable
instead ofredux
import from@americanexpress/vitruvius/immutable
.
import vitruvius from '@americanexpress/vitruvius';
const reducer = vitruvius({
stuff: stuffReducer,
things: thingsReducer,
...otherReducers,
});
const store = createStore(reducer, reducer.buildInitialState(locals), enhancer);
Contributing
We welcome Your interest in the American Express Open Source Community on Github. Any Contributor to any Open Source Project managed by the American Express Open Source Community must accept and sign an Agreement indicating agreement to the terms below. Except for the rights granted in this Agreement to American Express and to recipients of software distributed by American Express, You reserve all right, title, and interest, if any, in and to Your Contributions. Please fill out the Agreement.
License
Any contributions made under this project will be governed by the Apache License 2.0.
Code of Conduct
This project adheres to the American Express Community Guidelines. By participating, you are expected to honor these guidelines.