Actions
Actions are payloads of information that send data from your application to your store.
Action creators are functions that create actions. It's easy to conflate the terms “action” and “action creator,” so do your best to use the proper term.
Provided action creators
Redux REST Resource gives you ready-to-use action creators that will dispatch associated actions. Out of the box, you have the following actions configured:
You can check the default actions configuration
Available options
You can configure/override actions actions when using createResource
:
Every configuration can be specified at either a global level:
Or at the action level:
Fetch related options
Option name
Type
Default
Description
Example
url
String / Function
Required
Base URL to fetch
"https://foo.com/users/:id"
method
String / Function
"GET"
HTTP method
"PATCH"
headers
Object / Function
{}
Headers to be sent along
{Authorization: 'Bearer foo'}
query
Object / Function
{}
Query params
{from: 10, until: 20}
credentials
String / Function
undefined
Credentials
"include"
body
String / Function
undefined
HTTP body override
{foo: 'bar'}
Every option also accept a function that will receive the getState
helper, to act against the current state.
Every option can also be used at action call-time:
Reduce related options
Option name
Type
Default
Description
isArray
Boolean
false
Whether the expected response is an Array
assignResponse
Boolean
false
Whether to assign the response
isPure
Boolean
false
Whether to skip the HTTP request
Dispatched actions
We're using a dedicated status
field in our actions to reflect the Promise state.
For instance, fetchUsers()
will dispatch the following actions:
Every REST action creator will dispatch at most two actions based on the async status of the request.
Last updated