Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RickWong/fetch-plus
🐕 Fetch API with middlewares
https://github.com/RickWong/fetch-plus
ajax csrf fetch fetch-plus http immutablejs isomorphic json nodejs promises rest user-agent xml
Last synced: about 2 months ago
JSON representation
🐕 Fetch API with middlewares
- Host: GitHub
- URL: https://github.com/RickWong/fetch-plus
- Owner: RickWong
- License: bsd-3-clause
- Created: 2015-11-24T00:21:55.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-08-18T04:19:15.000Z (over 4 years ago)
- Last Synced: 2024-11-06T18:56:18.801Z (3 months ago)
- Topics: ajax, csrf, fetch, fetch-plus, http, immutablejs, isomorphic, json, nodejs, promises, rest, user-agent, xml
- Language: JavaScript
- Homepage:
- Size: 628 KB
- Stars: 119
- Watchers: 5
- Forks: 15
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Fetch+
A convenient [Fetch API](https://github.com/whatwg/fetch) library with first-class middleware support.
[](https://npmjs.org/package/fetch-plus)  [](http://packagequality.com/#?package=fetch-plus) 
## Features
- Drop-in replacement for fetch().
- Simple [BREAD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) methods for consuming REST APIs.
- A "queries" object option for building safe query strings more easily.
- All options can be computed values: `myHeaders: () => values`
- Custom middlewares to manipute requests, responses, and caught errors.
- Useful middlewares and handlers (JSON/Auth/CSRF/Immutable etc) available as separate npm packages.
- [Fetch API Streams draft](https://github.com/yutakahirano/fetch-with-streams) handler with an Observable interface.
- Runs in Node and all browsers.
## Installation
```bash
npm install --save fetch-plus isomorphic-fetch
```
## Additional middlewares
```bash
npm install --save fetch-plus-basicauth
npm install --save fetch-plus-bearerauth
npm install --save fetch-plus-csrf
npm install --save fetch-plus-immutable
npm install --save fetch-plus-json
npm install --save fetch-plus-oauth
npm install --save fetch-plus-stream
npm install --save fetch-plus-useragent
npm install --save fetch-plus-xml
```
## Usage
**import/require**
```js
import {fetch, createClient} from "fetch-plus";
```
**fetch**
```js
fetch("http://some.api.example/v1", {
query: {foo: "bar"}, // Query string object. So convenient.
body: () => "R2-D2" // Computed values are computed.
});
```
**createClient**
Creates a RESTful client so middlewares can be added to it.
```js
const client = createClient("http://some.api.example/v1");
```
**client.addMiddleware**
Create middlewares like: `(request) => (response) => response`
```js
client.addMiddleware(
(request) => {
request.path += ".json";
request.options.headers["Content-Type"] = "application/json; charset=utf-8";
return (response) => response.json();
}
);
```
**client.request**
`request` performs generic requests to the configured endpoint.
```js
client.request("posts/25/comments", {
method: "POST",
body: {comment: "C-3PO"}
});
```
**client.browse|read|edit|add|destroy|replace**
BREAD helpers that perform requests to the configured endpoint.
```js
client.browse(
"posts" // A string...
);
client.add(
["posts", 1, "comments"], // ...or an array like ["posts", id, "comments"]
{body: "C-3PO"} // Regular Fetch API body option.
);
```
**client.list|create|read|update|destroy**
CRUD aliases that perform requests to the configured endpoint.
```js
client.list(
"posts" // A string...
);
client.create(
["posts", 1, "comments"], // ...or an array like ["posts", id, "comments"]
{body: "C-3PO"} // Regular Fetch API body option.
);
```
**handlers**
Handlers take configuration and return functions to pass to `.then()`.
```js
// Transform JSON with fetch-plus-json.
import plusJson from "fetch-plus-json";
fetch("http://some.api.example/v1/posts").then(plusJson.handler({some:"config"}));
```
See [example](https://github.com/RickWong/fetch-plus/blob/master/example/src/index.js) for more.
## Community
Let's start one together! After you ★Star this project, follow me [@Rygu](https://twitter.com/rygu)
on Twitter.
## License
BSD 3-Clause license. Copyright © 2015, Rick Wong. All rights reserved.