Read Me
Dead simple and ready-to-use store module for handling HTTP REST resources.
🚧 Deprecation notice
This project is no longer maintained as better alternatives came out.
Please use RTK-Query from the Redux Toolkit project instead.
Description
Generates types, actions and reducers for you to easily interact with any REST API.
Saves you from writing a lot of boilerplate code and ensures that your code stays DRY.
Requires redux-thunk to handle async actions.
Relies on fetch to perform HTTP requests.
Built with TypeScript for static type checking with exported types along the library.
Check the full documentation (built with gitbook).
https://mgcrea.gitbook.io/redux-rest-resource/
Basically using a REST endpoint with Redux can be done with only a few lines:
NOTE: If you want to use this in environments without a builtin
fetch
implementation, you need to bring your own custom fetch polyfill.
Available scripts
Script | Description |
start | alias to |
test | Run unit tests |
test:watch | Watch unit tests |
test:coverage | Run unit tests with coverage |
lint | Run eslint static tests |
compile | Compile the library |
compile:watch | Watch compilation |
docs | Serve docs |
docs:compile | Compile docs |
Authors
Olivier Louvignes
http://olouv.com
http://github.com/mgcrea
Inspired by the AngularJS resource.
License
Last updated