0.30.2 • Published 4 months ago
rb-data-provider-json-server v0.30.2
rb-data-provider-json-server
A Restboard data provider for JSON REST server
Getting started
import createProvider from "rb-data-provider-json-server";
const provider = createProvider("https://jsonplaceholder.typicode.com");
provider
.getMany("posts")
.then((posts) => console.log(posts))
.catch((err) => console.error(err));
Additional options can be configured during the data provider construction:
const provider = createProvider("https://jsonplaceholder.typicode.com", {
timeout: 3000,
retries: 5,
backoff: 300,
});
REST Dialect
Method | API call |
---|---|
getMany | GET http://my.api.url/:resource |
getOne | GET http://my.api.url/:resource/:id |
createOne | POST http://my.api.url/:resource |
updateOne | PATCH http://my.api.url/:resource/:id |
updateMany | PATCH http://my.api.url/:resource |
deleteOne | DELETE http://my.api.url/:resource/:id |
deleteMany | DELETE http://my.api.url/:resource |
Options
Name | Description | Default |
---|---|---|
timeout | The timeout (ms) for each single HTTP request attempt | 5000 |
retries | The number of attempts before failing | 3 |
backoff | The incremental delay (ms) between request attempts | 500 |
client | The HTTP client used to perform the requests | fetch |
tokenGetter | An async function to get the bearer token to be used | undefined |
contentTypeParser | A function used to parse the content type of the request payload (if any) | (data) => 'application/json; charset=UTF-8' |
responseParser | A function to extract the payload from the response | undefined |
querystringRenderer | A function to render the request querystring | undefined |
idempotentUpdate | If true, the PUT method will be used on update requests | false |
cache | An optional cache object to store request responses. Should implement the following API: has(reqId) , get(reqId) , set(reqId,res) | undefined |
Test
npm test
Contribute
If you want, you can also freely donate to fund the project development:
Have you found a bug?
Please open a new issue on:
https://github.com/restboard/rb-data-provider-json-server/issues
Acknowledgements
This project is inspired by:
License
Copyright (c) Emanuele Bertoldi
0.30.2
4 months ago
0.30.1
4 months ago
0.30.0
4 months ago
0.29.1
9 months ago
0.29.0
1 year ago
0.28.1
1 year ago
0.28.0
1 year ago
0.27.0
1 year ago
0.26.0
1 year ago
0.25.1
1 year ago
0.25.0
2 years ago
0.24.0
2 years ago
0.21.0
2 years ago
0.20.0
2 years ago
0.19.1
2 years ago
0.23.0
2 years ago
0.22.0
2 years ago
0.19.0
2 years ago
0.18.0
2 years ago
0.17.0
3 years ago
0.16.0
3 years ago
0.13.0
3 years ago
0.14.0
3 years ago
0.15.0
3 years ago
0.11.0
3 years ago
0.12.0
3 years ago
0.10.0
3 years ago
0.9.0
3 years ago
0.8.1
3 years ago
0.8.2
3 years ago
0.8.0
3 years ago
0.7.1
3 years ago
0.7.0
3 years ago
0.5.0
3 years ago
0.4.1
3 years ago
0.4.0
3 years ago
0.3.0
3 years ago