@launchpadlab/lp-redux-api
v7.0.0
Published
redux middleware and api library
Downloads
611
Readme
lp-redux-api
Action creators and reducers for making API requests with redux.
// Define an API action
import { createRequest } from '@launchpadlab/lp-redux-api'
const fetchUser = createRequest('FETCH_USER', (id) => ({
url: '/users/' + id,
}))
// Dispatch the action from a component (mapDispatchToProps not shown)
function Component({ fetchUser }) {
return <button onClick={() => fetchUser(5)}> Fetch user with id: 5 </button>
}
// Store the response in a reducer
import { handleActions } from 'redux-actions'
import { setOnSuccess } from '@launchpadlab/lp-redux-api'
const reducer = handleActions(
{
[fetchUser]: setOnSuccess('user'),
},
{}
)
// state.user will contain the response when the request completes.
The key functions in this library are:
createRequest(key, requestInfo)
- this function allows you to define a redux action that makes an API request asynchronously. By default, API requests are made using lp-requests, although this is configurable.setOnSuccess(path) | setOnFailure(path)
- these functions allow you to easily store the responses of API actions in your redux store.
Additional usage information, as well as a list of other helpers this library provides, can be found in the documentation.
Documentation
Documentation and usage info can be found in docs.md.
Migration Guides
Contribution
This package follows the Opex NPM package guidelines. Please refer to the linked document for information on contributing, testing and versioning.