Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thinkjs/think-fetch
Fetch for ThinkJS 3.x
https://github.com/thinkjs/think-fetch
fetch think-extend thinkjs3
Last synced: about 1 month ago
JSON representation
Fetch for ThinkJS 3.x
- Host: GitHub
- URL: https://github.com/thinkjs/think-fetch
- Owner: thinkjs
- License: mit
- Created: 2017-03-30T02:30:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-09-10T18:02:41.000Z (over 4 years ago)
- Last Synced: 2024-10-01T08:49:10.605Z (2 months ago)
- Topics: fetch, think-extend, thinkjs3
- Language: JavaScript
- Homepage:
- Size: 15.6 KB
- Stars: 10
- Watchers: 13
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- think-awesome - think-fetch
README
# think-fetch
[](https://www.npmjs.com/package/think-fetch)
[](https://travis-ci.org/thinkjs/think-fetch)
[](https://coveralls.io/github/thinkjs/think-fetch?branch=master)
Fetch for ThinkJS 3.x
## Install
```
$ npm install think-fetch --save
```
## How to use
config file `src/config/extend.js`
```javascript
const fetch = require('think-fetch');
module.exports = [
fetch, // HTTP request client.
];
```
## Methods in Controller
```javascript
module.exports = class extends think.Controller {
async indexAction () {
// plain text or html
const text = await this.fetch('https://github.com/').then(res => res.text());
// json
const json = await this.fetch('https://api.github.com/repos/thinkjs/think-fetch').then(res => res.json());
// post
const body = await this.fetch('http://httpbin.org/post', { method: 'POST', body: 'a=1' }).then(res => res.json());
// stream
const res = await this.fetch('https://assets-cdn.github.com/images/modules/logos_page/Octocat.png');
const dest = fs.createWriteStream('./octocat.png');
res.body.pipe(dest);
// post with stream from file
const stream = fs.createReadStream('input.txt');
const result = this.fetch('http://httpbin.org/post', { method: 'POST', body: stream }).then(res => res.json());
}
}
```
## API
### fetch(url[, options])
- `url` A string representing the URL for fetching
- `options` [Options](#options) for the HTTP(S) request
- Returns: `Promise`
Perform an HTTP(S) fetch.
url should be an absolute url, such as `http://example.com/`. A path-relative URL (`/file/under/root`) or protocol-relative URL (`//can-be-http-or-https.com/`) will result in a rejected promise.
#### Options
The default values are shown after each option key.
```javascript
{
// These properties are part of the Fetch Standard
method: 'GET',
headers: {}, // request headers. format is the identical to that accepted by the Headers constructor (see below)
body: null, // request body. can be null, a string, a Buffer, a Blob, or a Node.js Readable stream
redirect: 'follow', // set to `manual` to extract redirect headers, `error` to reject redirect
// The following properties are node-fetch extensions
follow: 20, // maximum redirect count. 0 to not follow redirect
timeout: 0, // req/res timeout in ms, it resets on redirect. 0 to disable (OS limit applies)
compress: true, // support gzip/deflate content encoding. false to disable
size: 0, // maximum response body size in bytes. 0 to disable
agent: null // http(s).Agent instance, allows custom proxy, certificate etc.
}
```
##### Default Headers
If no values are set, the following request headers will be sent automatically:
| Header | Value |
| :------: | :------: |
| `Accept-Encoding` | `gzip,deflate` (when `options.compress === true`) |
| `Accept` | `*/*` |
| `Connection` | `close` (when no `options.agent` is present) |
| `Content-Length` | (automatically calculated, if possible) |
| `User-Agent` | `node-fetch/1.0 (+https://github.com/bitinn/node-fetch)` |
[More Methods Click](https://github.com/bitinn/node-fetch)