Updating Resources
Last updated
Last updated
Redux Resource provides four for updating resources asynchronously. They are:
Each request will always begin with an action with type UPDATE_RESOURCES_PENDING
. Then, one of the other three action types will be used to represent the resolution of that request. Use the other action types in the following way:
UPDATE_RESOURCES_FAILED
: Use this if the request fails for any reason. This
could be network errors, or any
greater than or equal to 400.
UPDATE_RESOURCES_IDLE
: Use this when the request is aborted.
UPDATE_RESOURCES_SUCCEEDED
: Use this when the request was successful.
Specifying a on the actions will create a request object in the store for this request. This object can be used to look up the of the request.
Although it is recommended that you specify a request key whenever possible, there are some situations when you may not need to when updating resources.
For updates that target a single resource, you typically know the ID being updated upfront. Accordingly, you could use the resource metadata to track the status.
For update requests that return multiple resources, it is typically preferable to specify a request key.
When an action of type UPDATE_RESOURCES_SUCCEEDED
is dispatched, three things will happen:
the resources included in the action's resources
will be added to the resources
section of the resource slice. Existing resources with the same ID will be merged with the new ones. To replace existing resources, rather than merge them, specify mergeResources: false
on the action.
The metadata for each of the resources
specified on the action will be updated with updateStatus: 'SUCCEEDED'
. To replace all of the existing meta, rather than merging it, specify mergeMeta: false
on the action.
When a list
is passed, the IDs from the resources
array on the action will be added to the list. You may specify mergeListIds: false
to replace the existing list instead.
provides an action creator that simplifies making CRUD requests. If you'd like to build your own, then that's fine, too. The example below may help.
This example shows an action creator to update a single book. It uses the middleware and the library for making requests.