Redux Resource Action Creators
- 1.
- 2.Often times, your "start" and "end" actions share many properties, and it can feel like unnecessaryboilerplate to copy + paste those properties
Unlike Redux Resource XHR, these action creators do not make the requests for you. All this library does is create the actions themselves.
Old Documentation
Migration Guides
Install
redux-resource-action-creators
from npm:npm install redux-resource-action-creators --save
Then, import
createActionCreators
in your application:import createActionCreators from 'redux-resource-action-creators';
This library has a single export,
createActionCreators
.- 1.
crudAction
: (String) The CRUD operation being performed. One of "create", "read", "update", or "delete". This determines the CRUD Action types that are dispatched. - 2.
actionDefaults
(Object): Properties that will be included on each dispatched action. The Request Action guide lists possible options, such asresourceType
andresources
. You must includeresourceType
.
(
Object
): An object with four methods: pending
, succeeded
, failed
, and idle
. These action creators return actions for you, based on the action properties that you provide to them.import createActionCreators from 'redux-resource-action-creators';
import store from './store';
const readActionCreators = createActionCreators('read', {
resourceType: 'books',
requestKey: 'getHomePageBooks',
list: 'homePageBooks',
mergeListIds: false
});
store.dispatch(readActionCreators.pending());
const req = fetchData((err, res, body) => {
if (req.aborted) {
store.dispatch(readActionCreators.idle());
} else if (err) {
store.dispatch(readActionCreators.failed());
} else {
store.dispatch(readActionCreators.succeeded({
resources: body
}));
}
});
To understand why you might use this library, compare that example versus this common Redux Resource code:
import { actionTypes } from 'redux-resource';
import store from './store';
store.dispatch({
type: actionTypes.READ_RESOURCES_PENDING,
resourceType: 'books',
requestKey: 'getHomePageBooks',
list: 'homePageBooks'
});
const req = fetchData((err, res, body) => {
if (req.aborted) {
store.dispatch({
type: actionTypes.READ_RESOURCES_NULL,
resourceType: 'books',
requestKey: 'getHomePageBooks',
list: 'homePageBooks'
});
} else if (err) {
store.dispatch({
type: actionTypes.READ_RESOURCES_FAILED,
resourceType: 'books',
requestKey: 'getHomePageBooks',
list: 'homePageBooks'
});
} else {
store.dispatch(readActionCreators.succeeded({
type: actionTypes.READ_RESOURCES_SUCCEEDED,
resourceType: 'books',
requestKey: 'getHomePageBooks',
list: 'homePageBooks',
resources: body
}));
}
});
All that this library does is provides a simple pattern to write less, more expressive code. If you'd like, you could get many of the same benefits by defining shared action properties, and then spreading them in your actions:
import { actionTypes } from 'redux-resource';
import store from './store';
const actionDefaults = {
resourceType: 'books',
requestKey: 'getHomePageBooks',
list: 'homePageBooks'
};
store.dispatch({
...actionDefaults,
type: actionTypes.READ_RESOURCES_PENDING,
});
const req = fetchData((err, res, body) => {
if (req.aborted) {
store.dispatch({
...actionDefaults,
type: actionTypes.READ_RESOURCES_NULL,
});
} else if (err) {
store.dispatch({
...actionDefaults,
type: actionTypes.READ_RESOURCES_FAILED,
});
} else {
store.dispatch(readActionCreators.succeeded({
...actionDefaults,
type: actionTypes.READ_RESOURCES_SUCCEEDED,
resources: body
}));
}
});
Last modified 3yr ago