redux-types
v2.0.3
Published
Namespace type strings for redux dispatcher
Downloads
239
Maintainers
Readme
redux-types
Allows easy, consistent, and readable namespacing of redux actions.
Why
Action types for the redux dispatcher must be unique. An easy way to get uniqueness is with a namespace. It is common, for instance, that you would FETCH
things into many reducers. But each FETCH
must be distinguishable to the dispatcher. To solve this problem, we might namespace the types to be posts/FETCH
and comments/FETCH
, mapping to names of some models or features in our app.
This library ensures that you follow this pattern, producing clean, readable action type namespacing.
The function will throw an error if one of the args are not a string, or if you pass the same string twice.
Install
npm install redux-types --save-dev
or
yarn add -D redux-types
Usage
In your action types.js
definition module, you might write:
import types from 'redux-types'
const typesArray = ['CREATE', 'EDIT', 'DELETE'];
export default types('posts', typesArray)
You can also compose arrays for a better DRY styled code :
import types from 'redux-types'
const CRUDTypes = ['CREATE', 'EDIT', 'DELETE']; // both arrays could be
const fetchTypes = ['FETCH_SUCCESS', 'FETCH_PENDING', 'FETCH_ERROR']; // imported from a constants file
const someSpeficicAction = 'SPECIFIC';
export const PostTypes = [...CRUDTypes, ...fetchTypes, someSpeficicAction]; // exported for tests purposes
export default types('posts', PostTypes)
And then be able to use these in your actions.js
creators:
import TYPES from './types'
export function createPost(post) {
return {
type: TYPES.CREATE,
post
}
}