Read Me
Dead simple and ready-to-use store module for handling HTTP REST resources.
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).

Preview

Basically using a REST endpoint with Redux can be done with only a few lines:
1
import {createResource} from 'redux-rest-resource';
2
3
const hostUrl = 'https://api.mlab.com:443/api/1/databases/sandbox/collections';
4
const apiKey = 'xvDjirE9MCIi800xMxi4EKeTm8e9FUBR';
5
6
type User = {
7
id: string;
8
firstName: string;
9
lastName: string;
10
};
11
12
export const {types, actions, rootReducer} = createResource<User>({
13
name: 'user',
14
url: `${hostUrl}/users/:id?apiKey=${apiKey}`
15
});
Copied!
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:watch
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
Inspired by the AngularJS resource.

License

1
The MIT License
2
3
Copyright (c) 2016 Olivier Louvignes
4
5
Permission is hereby granted, free of charge, to any person obtaining a copy
6
of this software and associated documentation files (the "Software"), to deal
7
in the Software without restriction, including without limitation the rights
8
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
copies of the Software, and to permit persons to whom the Software is
10
furnished to do so, subject to the following conditions:
11
12
The above copyright notice and this permission notice shall be included in
13
all copies or substantial portions of the Software.
14
15
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
THE SOFTWARE.
Copied!
Last modified 1yr ago