forked from hexbear-collective/lemmy-hexbear
11 changed files with 5944 additions and 0 deletions
-
29node_modules/.yarn-integrity
-
272node_modules/node-fetch/CHANGELOG.md
-
22node_modules/node-fetch/LICENSE.md
-
590node_modules/node-fetch/README.md
-
25node_modules/node-fetch/browser.js
-
1640node_modules/node-fetch/lib/index.es.js
-
1649node_modules/node-fetch/lib/index.js
-
1638node_modules/node-fetch/lib/index.mjs
-
66node_modules/node-fetch/package.json
-
5package.json
-
8yarn.lock
@ -0,0 +1,29 @@ |
|||
{ |
|||
"systemParams": "darwin-x64-72", |
|||
"modulesFolders": [ |
|||
"node_modules" |
|||
], |
|||
"flags": [], |
|||
"linkedModules": [ |
|||
"@cratebind/react", |
|||
"@cratebind/react-components", |
|||
"components", |
|||
"cratebind-react-library", |
|||
"eslint-config-cratebind", |
|||
"generator-cratebind-react", |
|||
"js-library-example", |
|||
"minerva-ui", |
|||
"pg-commands", |
|||
"react", |
|||
"react-example", |
|||
"run-node-script" |
|||
], |
|||
"topLevelPatterns": [ |
|||
"[email protected]^2.6.1" |
|||
], |
|||
"lockfileEntries": { |
|||
"[email protected]^2.6.1": "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.1.tgz#045bd323631f76ed2e2b55573394416b639a0052" |
|||
}, |
|||
"files": [], |
|||
"artifacts": {} |
|||
} |
@ -0,0 +1,272 @@ |
|||
|
|||
Changelog |
|||
========= |
|||
|
|||
|
|||
# 2.x release |
|||
|
|||
## v2.6.1 |
|||
|
|||
**This is an important security release. It is strongly recommended to update as soon as possible.** |
|||
|
|||
- Fix: honor the `size` option after following a redirect. |
|||
|
|||
## v2.6.0 |
|||
|
|||
- Enhance: `options.agent`, it now accepts a function that returns custom http(s).Agent instance based on current URL, see readme for more information. |
|||
- Fix: incorrect `Content-Length` was returned for stream body in 2.5.0 release; note that `node-fetch` doesn't calculate content length for stream body. |
|||
- Fix: `Response.url` should return empty string instead of `null` by default. |
|||
|
|||
## v2.5.0 |
|||
|
|||
- Enhance: `Response` object now includes `redirected` property. |
|||
- Enhance: `fetch()` now accepts third-party `Blob` implementation as body. |
|||
- Other: disable `package-lock.json` generation as we never commit them. |
|||
- Other: dev dependency update. |
|||
- Other: readme update. |
|||
|
|||
## v2.4.1 |
|||
|
|||
- Fix: `Blob` import rule for node < 10, as `Readable` isn't a named export. |
|||
|
|||
## v2.4.0 |
|||
|
|||
- Enhance: added `Brotli` compression support (using node's zlib). |
|||
- Enhance: updated `Blob` implementation per spec. |
|||
- Fix: set content type automatically for `URLSearchParams`. |
|||
- Fix: `Headers` now reject empty header names. |
|||
- Fix: test cases, as node 12+ no longer accepts invalid header response. |
|||
|
|||
## v2.3.0 |
|||
|
|||
- Enhance: added `AbortSignal` support, with README example. |
|||
- Enhance: handle invalid `Location` header during redirect by rejecting them explicitly with `FetchError`. |
|||
- Fix: update `browser.js` to support react-native environment, where `self` isn't available globally. |
|||
|
|||
## v2.2.1 |
|||
|
|||
- Fix: `compress` flag shouldn't overwrite existing `Accept-Encoding` header. |
|||
- Fix: multiple `import` rules, where `PassThrough` etc. doesn't have a named export when using node <10 and `--exerimental-modules` flag. |
|||
- Other: Better README. |
|||
|
|||
## v2.2.0 |
|||
|
|||
- Enhance: Support all `ArrayBuffer` view types |
|||
- Enhance: Support Web Workers |
|||
- Enhance: Support Node.js' `--experimental-modules` mode; deprecate `.es.js` file |
|||
- Fix: Add `__esModule` property to the exports object |
|||
- Other: Better example in README for writing response to a file |
|||
- Other: More tests for Agent |
|||
|
|||
## v2.1.2 |
|||
|
|||
- Fix: allow `Body` methods to work on `ArrayBuffer`-backed `Body` objects |
|||
- Fix: reject promise returned by `Body` methods when the accumulated `Buffer` exceeds the maximum size |
|||
- Fix: support custom `Host` headers with any casing |
|||
- Fix: support importing `fetch()` from TypeScript in `browser.js` |
|||
- Fix: handle the redirect response body properly |
|||
|
|||
## v2.1.1 |
|||
|
|||
Fix packaging errors in v2.1.0. |
|||
|
|||
## v2.1.0 |
|||
|
|||
- Enhance: allow using ArrayBuffer as the `body` of a `fetch()` or `Request` |
|||
- Fix: store HTTP headers of a `Headers` object internally with the given case, for compatibility with older servers that incorrectly treated header names in a case-sensitive manner |
|||
- Fix: silently ignore invalid HTTP headers |
|||
- Fix: handle HTTP redirect responses without a `Location` header just like non-redirect responses |
|||
- Fix: include bodies when following a redirection when appropriate |
|||
|
|||
## v2.0.0 |
|||
|
|||
This is a major release. Check [our upgrade guide](https://github.com/bitinn/node-fetch/blob/master/UPGRADE-GUIDE.md) for an overview on some key differences between v1 and v2. |
|||
|
|||
### General changes |
|||
|
|||
- Major: Node.js 0.10.x and 0.12.x support is dropped |
|||
- Major: `require('node-fetch/lib/response')` etc. is now unsupported; use `require('node-fetch').Response` or ES6 module imports |
|||
- Enhance: start testing on Node.js v4.x, v6.x, v8.x LTS, as well as v9.x stable |
|||
- Enhance: use Rollup to produce a distributed bundle (less memory overhead and faster startup) |
|||
- Enhance: make `Object.prototype.toString()` on Headers, Requests, and Responses return correct class strings |
|||
- Other: rewrite in ES2015 using Babel |
|||
- Other: use Codecov for code coverage tracking |
|||
- Other: update package.json script for npm 5 |
|||
- Other: `encoding` module is now optional (alpha.7) |
|||
- Other: expose browser.js through package.json, avoid bundling mishaps (alpha.9) |
|||
- Other: allow TypeScript to `import` node-fetch by exposing default (alpha.9) |
|||
|
|||
### HTTP requests |
|||
|
|||
- Major: overwrite user's `Content-Length` if we can be sure our information is correct (per spec) |
|||
- Fix: errors in a response are caught before the body is accessed |
|||
- Fix: support WHATWG URL objects, created by `whatwg-url` package or `require('url').URL` in Node.js 7+ |
|||
|
|||
### Response and Request classes |
|||
|
|||
- Major: `response.text()` no longer attempts to detect encoding, instead always opting for UTF-8 (per spec); use `response.textConverted()` for the v1 behavior |
|||
- Major: make `response.json()` throw error instead of returning an empty object on 204 no-content respose (per spec; reverts behavior changed in v1.6.2) |
|||
- Major: internal methods are no longer exposed |
|||
- Major: throw error when a `GET` or `HEAD` Request is constructed with a non-null body (per spec) |
|||
- Enhance: add `response.arrayBuffer()` (also applies to Requests) |
|||
- Enhance: add experimental `response.blob()` (also applies to Requests) |
|||
- Enhance: `URLSearchParams` is now accepted as a body |
|||
- Enhance: wrap `response.json()` json parsing error as `FetchError` |
|||
- Fix: fix Request and Response with `null` body |
|||
|
|||
### Headers class |
|||
|
|||
- Major: remove `headers.getAll()`; make `get()` return all headers delimited by commas (per spec) |
|||
- Enhance: make Headers iterable |
|||
- Enhance: make Headers constructor accept an array of tuples |
|||
- Enhance: make sure header names and values are valid in HTTP |
|||
- Fix: coerce Headers prototype function parameters to strings, where applicable |
|||
|
|||
### Documentation |
|||
|
|||
- Enhance: more comprehensive API docs |
|||
- Enhance: add a list of default headers in README |
|||
|
|||
|
|||
# 1.x release |
|||
|
|||
## backport releases (v1.7.0 and beyond) |
|||
|
|||
See [changelog on 1.x branch](https://github.com/bitinn/node-fetch/blob/1.x/CHANGELOG.md) for details. |
|||
|
|||
## v1.6.3 |
|||
|
|||
- Enhance: error handling document to explain `FetchError` design |
|||
- Fix: support `form-data` 2.x releases (requires `form-data` >= 2.1.0) |
|||
|
|||
## v1.6.2 |
|||
|
|||
- Enhance: minor document update |
|||
- Fix: response.json() returns empty object on 204 no-content response instead of throwing a syntax error |
|||
|
|||
## v1.6.1 |
|||
|
|||
- Fix: if `res.body` is a non-stream non-formdata object, we will call `body.toString` and send it as a string |
|||
- Fix: `counter` value is incorrectly set to `follow` value when wrapping Request instance |
|||
- Fix: documentation update |
|||
|
|||
## v1.6.0 |
|||
|
|||
- Enhance: added `res.buffer()` api for convenience, it returns body as a Node.js buffer |
|||
- Enhance: better old server support by handling raw deflate response |
|||
- Enhance: skip encoding detection for non-HTML/XML response |
|||
- Enhance: minor document update |
|||
- Fix: HEAD request doesn't need decompression, as body is empty |
|||
- Fix: `req.body` now accepts a Node.js buffer |
|||
|
|||
## v1.5.3 |
|||
|
|||
- Fix: handle 204 and 304 responses when body is empty but content-encoding is gzip/deflate |
|||
- Fix: allow resolving response and cloned response in any order |
|||
- Fix: avoid setting `content-length` when `form-data` body use streams |
|||
- Fix: send DELETE request with content-length when body is present |
|||
- Fix: allow any url when calling new Request, but still reject non-http(s) url in fetch |
|||
|
|||
## v1.5.2 |
|||
|
|||
- Fix: allow node.js core to handle keep-alive connection pool when passing a custom agent |
|||
|
|||
## v1.5.1 |
|||
|
|||
- Fix: redirect mode `manual` should work even when there is no redirection or broken redirection |
|||
|
|||
## v1.5.0 |
|||
|
|||
- Enhance: rejected promise now use custom `Error` (thx to @pekeler) |
|||
- Enhance: `FetchError` contains `err.type` and `err.code`, allows for better error handling (thx to @pekeler) |
|||
- Enhance: basic support for redirect mode `manual` and `error`, allows for location header extraction (thx to @jimmywarting for the initial PR) |
|||
|
|||
## v1.4.1 |
|||
|
|||
- Fix: wrapping Request instance with FormData body again should preserve the body as-is |
|||
|
|||
## v1.4.0 |
|||
|
|||
- Enhance: Request and Response now have `clone` method (thx to @kirill-konshin for the initial PR) |
|||
- Enhance: Request and Response now have proper string and buffer body support (thx to @kirill-konshin) |
|||
- Enhance: Body constructor has been refactored out (thx to @kirill-konshin) |
|||
- Enhance: Headers now has `forEach` method (thx to @tricoder42) |
|||
- Enhance: back to 100% code coverage |
|||
- Fix: better form-data support (thx to @item4) |
|||
- Fix: better character encoding detection under chunked encoding (thx to @dsuket for the initial PR) |
|||
|
|||
## v1.3.3 |
|||
|
|||
- Fix: make sure `Content-Length` header is set when body is string for POST/PUT/PATCH requests |
|||
- Fix: handle body stream error, for cases such as incorrect `Content-Encoding` header |
|||
- Fix: when following certain redirects, use `GET` on subsequent request per Fetch Spec |
|||
- Fix: `Request` and `Response` constructors now parse headers input using `Headers` |
|||
|
|||
## v1.3.2 |
|||
|
|||
- Enhance: allow auto detect of form-data input (no `FormData` spec on node.js, this is form-data specific feature) |
|||
|
|||
## v1.3.1 |
|||
|
|||
- Enhance: allow custom host header to be set (server-side only feature, as it's a forbidden header on client-side) |
|||
|
|||
## v1.3.0 |
|||
|
|||
- Enhance: now `fetch.Request` is exposed as well |
|||
|
|||
## v1.2.1 |
|||
|
|||
- Enhance: `Headers` now normalized `Number` value to `String`, prevent common mistakes |
|||
|
|||
## v1.2.0 |
|||
|
|||
- Enhance: now fetch.Headers and fetch.Response are exposed, making testing easier |
|||
|
|||
## v1.1.2 |
|||
|
|||
- Fix: `Headers` should only support `String` and `Array` properties, and ignore others |
|||
|
|||
## v1.1.1 |
|||
|
|||
- Enhance: now req.headers accept both plain object and `Headers` instance |
|||
|
|||
## v1.1.0 |
|||
|
|||
- Enhance: timeout now also applies to response body (in case of slow response) |
|||
- Fix: timeout is now cleared properly when fetch is done/has failed |
|||
|
|||
## v1.0.6 |
|||
|
|||
- Fix: less greedy content-type charset matching |
|||
|
|||
## v1.0.5 |
|||
|
|||
- Fix: when `follow = 0`, fetch should not follow redirect |
|||
- Enhance: update tests for better coverage |
|||
- Enhance: code formatting |
|||
- Enhance: clean up doc |
|||
|
|||
## v1.0.4 |
|||
|
|||
- Enhance: test iojs support |
|||
- Enhance: timeout attached to socket event only fire once per redirect |
|||
|
|||
## v1.0.3 |
|||
|
|||
- Fix: response size limit should reject large chunk |
|||
- Enhance: added character encoding detection for xml, such as rss/atom feed (encoding in DTD) |
|||
|
|||
## v1.0.2 |
|||
|
|||
- Fix: added res.ok per spec change |
|||
|
|||
## v1.0.0 |
|||
|
|||
- Enhance: better test coverage and doc |
|||
|
|||
|
|||
# 0.x release |
|||
|
|||
## v0.1 |
|||
|
|||
- Major: initial public release |
@ -0,0 +1,22 @@ |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2016 David Frank |
|||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a copy |
|||
of this software and associated documentation files (the "Software"), to deal |
|||
in the Software without restriction, including without limitation the rights |
|||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|||
copies of the Software, and to permit persons to whom the Software is |
|||
furnished to do so, subject to the following conditions: |
|||
|
|||
The above copyright notice and this permission notice shall be included in all |
|||
copies or substantial portions of the Software. |
|||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|||
SOFTWARE. |
|||
|
@ -0,0 +1,590 @@ |
|||
node-fetch |
|||
========== |
|||
|
|||
[![npm version][npm-image]][npm-url] |
|||
[![build status][travis-image]][travis-url] |
|||
[![coverage status][codecov-image]][codecov-url] |
|||
[![install size][install-size-image]][install-size-url] |
|||
[![Discord][discord-image]][discord-url] |
|||
|
|||
A light-weight module that brings `window.fetch` to Node.js |
|||
|
|||
(We are looking for [v2 maintainers and collaborators](https://github.com/bitinn/node-fetch/issues/567)) |
|||
|
|||
[![Backers][opencollective-image]][opencollective-url] |
|||
|
|||
<!-- TOC --> |
|||
|
|||
- [Motivation](#motivation) |
|||
- [Features](#features) |
|||
- [Difference from client-side fetch](#difference-from-client-side-fetch) |
|||
- [Installation](#installation) |
|||
- [Loading and configuring the module](#loading-and-configuring-the-module) |
|||
- [Common Usage](#common-usage) |
|||
- [Plain text or HTML](#plain-text-or-html) |
|||
- [JSON](#json) |
|||
- [Simple Post](#simple-post) |
|||
- [Post with JSON](#post-with-json) |
|||
- [Post with form parameters](#post-with-form-parameters) |
|||
- [Handling exceptions](#handling-exceptions) |
|||
- [Handling client and server errors](#handling-client-and-server-errors) |
|||
- [Advanced Usage](#advanced-usage) |
|||
- [Streams](#streams) |
|||
- [Buffer](#buffer) |
|||
- [Accessing Headers and other Meta data](#accessing-headers-and-other-meta-data) |
|||
- [Extract Set-Cookie Header](#extract-set-cookie-header) |
|||
- [Post data using a file stream](#post-data-using-a-file-stream) |
|||
- [Post with form-data (detect multipart)](#post-with-form-data-detect-multipart) |
|||
- [Request cancellation with AbortSignal](#request-cancellation-with-abortsignal) |
|||
- [API](#api) |
|||
- [fetch(url[, options])](#fetchurl-options) |
|||
- [Options](#options) |
|||
- [Class: Request](#class-request) |
|||
- [Class: Response](#class-response) |
|||
- [Class: Headers](#class-headers) |
|||
- [Interface: Body](#interface-body) |
|||
- [Class: FetchError](#class-fetcherror) |
|||
- [License](#license) |
|||
- [Acknowledgement](#acknowledgement) |
|||
|
|||
<!-- /TOC --> |
|||
|
|||
## Motivation |
|||
|
|||
Instead of implementing `XMLHttpRequest` in Node.js to run browser-specific [Fetch polyfill](https://github.com/github/fetch), why not go from native `http` to `fetch` API directly? Hence, `node-fetch`, minimal code for a `window.fetch` compatible API on Node.js runtime. |
|||
|
|||
See Matt Andrews' [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch) or Leonardo Quixada's [cross-fetch](https://github.com/lquixada/cross-fetch) for isomorphic usage (exports `node-fetch` for server-side, `whatwg-fetch` for client-side). |
|||
|
|||
## Features |
|||
|
|||
- Stay consistent with `window.fetch` API. |
|||
- Make conscious trade-off when following [WHATWG fetch spec][whatwg-fetch] and [stream spec](https://streams.spec.whatwg.org/) implementation details, document known differences. |
|||
- Use native promise but allow substituting it with [insert your favorite promise library]. |
|||
- Use native Node streams for body on both request and response. |
|||
- Decode content encoding (gzip/deflate) properly and convert string output (such as `res.text()` and `res.json()`) to UTF-8 automatically. |
|||
- Useful extensions such as timeout, redirect limit, response size limit, [explicit errors](ERROR-HANDLING.md) for troubleshooting. |
|||
|
|||
## Difference from client-side fetch |
|||
|
|||
- See [Known Differences](LIMITS.md) for details. |
|||
- If you happen to use a missing feature that `window.fetch` offers, feel free to open an issue. |
|||
- Pull requests are welcomed too! |
|||
|
|||
## Installation |
|||
|
|||
Current stable release (`2.x`) |
|||
|
|||
```sh |
|||
$ npm install node-fetch |
|||
``` |
|||
|
|||
## Loading and configuring the module |
|||
We suggest you load the module via `require` until the stabilization of ES modules in node: |
|||
```js |
|||
const fetch = require('node-fetch'); |
|||
``` |
|||
|
|||
If you are using a Promise library other than native, set it through `fetch.Promise`: |
|||
```js |
|||
const Bluebird = require('bluebird'); |
|||
|
|||
fetch.Promise = Bluebird; |
|||
``` |
|||
|
|||
## Common Usage |
|||
|
|||
NOTE: The documentation below is up-to-date with `2.x` releases; see the [`1.x` readme](https://github.com/bitinn/node-fetch/blob/1.x/README.md), [changelog](https://github.com/bitinn/node-fetch/blob/1.x/CHANGELOG.md) and [2.x upgrade guide](UPGRADE-GUIDE.md) for the differences. |
|||
|
|||
#### Plain text or HTML |
|||
```js |
|||
fetch('https://github.com/') |
|||
.then(res => res.text()) |
|||
.then(body => console.log(body)); |
|||
``` |
|||
|
|||
#### JSON |
|||
|
|||
```js |
|||
|
|||
fetch('https://api.github.com/users/github') |
|||
.then(res => res.json()) |
|||
.then(json => console.log(json)); |
|||
``` |
|||
|
|||
#### Simple Post |
|||
```js |
|||
fetch('https://httpbin.org/post', { method: 'POST', body: 'a=1' }) |
|||
.then(res => res.json()) // expecting a json response |
|||
.then(json => console.log(json)); |
|||
``` |
|||
|
|||
#### Post with JSON |
|||
|
|||
```js |
|||
const body = { a: 1 }; |
|||
|
|||
fetch('https://httpbin.org/post', { |
|||
method: 'post', |
|||
body: JSON.stringify(body), |
|||
headers: { 'Content-Type': 'application/json' }, |
|||
}) |
|||
.then(res => res.json()) |
|||
.then(json => console.log(json)); |
|||
``` |
|||
|
|||
#### Post with form parameters |
|||
`URLSearchParams` is available in Node.js as of v7.5.0. See [official documentation](https://nodejs.org/api/url.html#url_class_urlsearchparams) for more usage methods. |
|||
|
|||
NOTE: The `Content-Type` header is only set automatically to `x-www-form-urlencoded` when an instance of `URLSearchParams` is given as such: |
|||
|
|||
```js |
|||
const { URLSearchParams } = require('url'); |
|||
|
|||
const params = new URLSearchParams(); |
|||
params.append('a', 1); |
|||
|
|||
fetch('https://httpbin.org/post', { method: 'POST', body: params }) |
|||
.then(res => res.json()) |
|||
.then(json => console.log(json)); |
|||
``` |
|||
|
|||
#### Handling exceptions |
|||
NOTE: 3xx-5xx responses are *NOT* exceptions and should be handled in `then()`; see the next section for more information. |
|||
|
|||
Adding a catch to the fetch promise chain will catch *all* exceptions, such as errors originating from node core libraries, network errors and operational errors, which are instances of FetchError. See the [error handling document](ERROR-HANDLING.md) for more details. |
|||
|
|||
```js |
|||
fetch('https://domain.invalid/') |
|||
.catch(err => console.error(err)); |
|||
``` |
|||
|
|||
#### Handling client and server errors |
|||
It is common to create a helper function to check that the response contains no client (4xx) or server (5xx) error responses: |
|||
|
|||
```js |
|||
function checkStatus(res) { |
|||
if (res.ok) { // res.status >= 200 && res.status < 300 |
|||
return res; |
|||
} else { |
|||
throw MyCustomError(res.statusText); |
|||
} |
|||
} |
|||
|
|||
fetch('https://httpbin.org/status/400') |
|||
.then(checkStatus) |
|||
.then(res => console.log('will not get here...')) |
|||
``` |
|||
|
|||
## Advanced Usage |
|||
|
|||
#### Streams |
|||
The "Node.js way" is to use streams when possible: |
|||
|
|||
```js |
|||
fetch('https://assets-cdn.github.com/images/modules/logos_page/Octocat.png') |
|||
.then(res => { |
|||
const dest = fs.createWriteStream('./octocat.png'); |
|||
res.body.pipe(dest); |
|||
}); |
|||
``` |
|||
|
|||
#### Buffer |
|||
If you prefer to cache binary data in full, use buffer(). (NOTE: `buffer()` is a `node-fetch`-only API) |
|||
|
|||
```js |
|||
const fileType = require('file-type'); |
|||
|
|||
fetch('https://assets-cdn.github.com/images/modules/logos_page/Octocat.png') |
|||
.then(res => res.buffer()) |
|||
.then(buffer => fileType(buffer)) |
|||
.then(type => { /* ... */ }); |
|||
``` |
|||
|
|||
#### Accessing Headers and other Meta data |
|||
```js |
|||
fetch('https://github.com/') |
|||
.then(res => { |
|||
console.log(res.ok); |
|||
console.log(res.status); |
|||
console.log(res.statusText); |
|||
console.log(res.headers.raw()); |
|||
console.log(res.headers.get('content-type')); |
|||
}); |
|||
``` |
|||
|
|||
#### Extract Set-Cookie Header |
|||
|
|||
Unlike browsers, you can access raw `Set-Cookie` headers manually using `Headers.raw()`. This is a `node-fetch` only API. |
|||
|
|||
```js |
|||
fetch(url).then(res => { |
|||
// returns an array of values, instead of a string of comma-separated values |
|||
console.log(res.headers.raw()['set-cookie']); |
|||
}); |
|||
``` |
|||
|
|||
#### Post data using a file stream |
|||
|
|||
```js |
|||
const { createReadStream } = require('fs'); |
|||
|
|||
const stream = createReadStream('input.txt'); |
|||
|
|||
fetch('https://httpbin.org/post', { method: 'POST', body: stream }) |
|||
.then(res => res.json()) |
|||
.then(json => console.log(json)); |
|||
``` |
|||
|
|||
#### Post with form-data (detect multipart) |
|||
|
|||
```js |
|||
const FormData = require('form-data'); |
|||
|
|||
const form = new FormData(); |
|||
form.append('a', 1); |
|||
|
|||
fetch('https://httpbin.org/post', { method: 'POST', body: form }) |
|||
.then(res => res.json()) |
|||
.then(json => console.log(json)); |
|||
|
|||
// OR, using custom headers |
|||
// NOTE: getHeaders() is non-standard API |
|||
|
|||
const form = new FormData(); |
|||
form.append('a', 1); |
|||
|
|||
const options = { |
|||
method: 'POST', |
|||
body: form, |
|||
headers: form.getHeaders() |
|||
} |
|||
|
|||
fetch('https://httpbin.org/post', options) |
|||
.then(res => res.json()) |
|||
.then(json => console.log(json)); |
|||
``` |
|||
|
|||
#### Request cancellation with AbortSignal |
|||
|
|||
> NOTE: You may cancel streamed requests only on Node >= v8.0.0 |
|||
|
|||
You may cancel requests with `AbortController`. A suggested implementation is [`abort-controller`](https://www.npmjs.com/package/abort-controller). |
|||
|
|||
An example of timing out a request after 150ms could be achieved as the following: |
|||
|
|||
```js |
|||
import AbortController from 'abort-controller'; |
|||
|
|||
const controller = new AbortController(); |
|||
const timeout = setTimeout( |
|||
() => { controller.abort(); }, |
|||
150, |
|||
); |
|||
|
|||
fetch(url, { signal: controller.signal }) |
|||
.then(res => res.json()) |
|||
.then( |
|||
data => { |
|||
useData(data) |
|||
}, |
|||
err => { |
|||
if (err.name === 'AbortError') { |
|||
// request was aborted |
|||
} |
|||
}, |
|||
) |
|||
.finally(() => { |
|||
clearTimeout(timeout); |
|||
}); |
|||
``` |
|||
|
|||
See [test cases](https://github.com/bitinn/node-fetch/blob/master/test/test.js) for more examples. |
|||
|
|||
|
|||
## API |
|||
|
|||
### fetch(url[, options]) |
|||
|
|||
- `url` A string representing the URL for fetching |
|||
- `options` [Options](#fetch-options) for the HTTP(S) request |
|||
- Returns: <code>Promise<[Response](#class-response)></code> |
|||
|
|||
Perform an HTTP(S) fetch. |
|||
|
|||
`url` should be an absolute url, such as `https://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`. |
|||
|
|||
<a id="fetch-options"></a> |
|||
### Options |
|||
|
|||
The default values are shown after each option key. |
|||
|
|||
```js |
|||
{ |
|||
// 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 |
|||
signal: null, // pass an instance of AbortSignal to optionally abort requests |
|||
|
|||
// 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). Signal is recommended instead. |
|||
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 or function that returns an instance (see below) |
|||
} |
|||
``` |
|||
|
|||
##### 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)_ |
|||
`Transfer-Encoding` | `chunked` _(when `req.body` is a stream)_ |
|||
`User-Agent` | `node-fetch/1.0 (+https://github.com/bitinn/node-fetch)` |
|||
|
|||
Note: when `body` is a `Stream`, `Content-Length` is not set automatically. |
|||
|
|||
##### Custom Agent |
|||
|
|||
The `agent` option allows you to specify networking related options which are out of the scope of Fetch, including and not limited to the following: |
|||
|
|||
- Support self-signed certificate |
|||
- Use only IPv4 or IPv6 |
|||
- Custom DNS Lookup |
|||
|
|||
See [`http.Agent`](https://nodejs.org/api/http.html#http_new_agent_options) for more information. |
|||
|
|||
In addition, the `agent` option accepts a function that returns `http`(s)`.Agent` instance given current [URL](https://nodejs.org/api/url.html), this is useful during a redirection chain across HTTP and HTTPS protocol. |
|||
|
|||
```js |
|||
const httpAgent = new http.Agent({ |
|||
keepAlive: true |
|||
}); |
|||
const httpsAgent = new https.Agent({ |
|||
keepAlive: true |
|||
}); |
|||
|
|||
const options = { |
|||
agent: function (_parsedURL) { |
|||
if (_parsedURL.protocol == 'http:') { |
|||
return httpAgent; |
|||
} else { |
|||
return httpsAgent; |
|||
} |
|||
} |
|||
} |
|||
``` |
|||
|
|||
<a id="class-request"></a> |
|||
### Class: Request |
|||
|
|||
An HTTP(S) request containing information about URL, method, headers, and the body. This class implements the [Body](#iface-body) interface. |
|||
|
|||
Due to the nature of Node.js, the following properties are not implemented at this moment: |
|||
|
|||
- `type` |
|||
- `destination` |
|||
- `referrer` |
|||
- `referrerPolicy` |
|||
- `mode` |
|||
- `credentials` |
|||
- `cache` |
|||
- `integrity` |
|||
- `keepalive` |
|||
|
|||
The following node-fetch extension properties are provided: |
|||
|
|||
- `follow` |
|||
- `compress` |
|||
- `counter` |
|||
- `agent` |
|||
|
|||
See [options](#fetch-options) for exact meaning of these extensions. |
|||
|
|||
#### new Request(input[, options]) |
|||
|
|||
<small>*(spec-compliant)*</small> |
|||
|
|||
- `input` A string representing a URL, or another `Request` (which will be cloned) |
|||
- `options` [Options][#fetch-options] for the HTTP(S) request |
|||
|
|||
Constructs a new `Request` object. The constructor is identical to that in the [browser](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request). |
|||
|
|||
In most cases, directly `fetch(url, options)` is simpler than creating a `Request` object. |
|||
|
|||
<a id="class-response"></a> |
|||
### Class: Response |
|||
|
|||
An HTTP(S) response. This class implements the [Body](#iface-body) interface. |
|||
|
|||
The following properties are not implemented in node-fetch at this moment: |
|||
|
|||
- `Response.error()` |
|||
- `Response.redirect()` |
|||
- `type` |
|||
- `trailer` |
|||
|
|||
#### new Response([body[, options]]) |
|||
|
|||
<small>*(spec-compliant)*</small> |
|||
|
|||
- `body` A `String` or [`Readable` stream][node-readable] |
|||
- `options` A [`ResponseInit`][response-init] options dictionary |
|||
|
|||
Constructs a new `Response` object. The constructor is identical to that in the [browser](https://developer.mozilla.org/en-US/docs/Web/API/Response/Response). |
|||
|
|||
Because Node.js does not implement service workers (for which this class was designed), one rarely has to construct a `Response` directly. |
|||
|
|||
#### response.ok |
|||
|
|||
<small>*(spec-compliant)*</small> |
|||
|
|||
Convenience property representing if the request ended normally. Will evaluate to true if the response status was greater than or equal to 200 but smaller than 300. |
|||
|
|||
#### response.redirected |
|||
|
|||
<small>*(spec-compliant)*</small> |
|||
|
|||
Convenience property representing if the request has been redirected at least once. Will evaluate to true if the internal redirect counter is greater than 0. |
|||
|
|||
<a id="class-headers"></a> |
|||
### Class: Headers |
|||
|
|||
This class allows manipulating and iterating over a set of HTTP headers. All methods specified in the [Fetch Standard][whatwg-fetch] are implemented. |
|||
|
|||
#### new Headers([init]) |
|||
|
|||
<small>*(spec-compliant)*</small> |
|||
|
|||
- `init` Optional argument to pre-fill the `Headers` object |
|||
|
|||
Construct a new `Headers` object. `init` can be either `null`, a `Headers` object, an key-value map object or any iterable object. |
|||
|
|||
```js |
|||
// Example adapted from https://fetch.spec.whatwg.org/#example-headers-class |
|||
|
|||
const meta = { |
|||
'Content-Type': 'text/xml', |
|||
'Breaking-Bad': '<3' |
|||
}; |
|||
const headers = new Headers(meta); |
|||
|
|||
// The above is equivalent to |
|||
const meta = [ |
|||
[ 'Content-Type', 'text/xml' ], |
|||
[ 'Breaking-Bad', '<3' ] |
|||
]; |
|||
const headers = new Headers(meta); |
|||
|
|||
// You can in fact use any iterable objects, like a Map or even another Headers |
|||
const meta = new Map(); |
|||
meta.set('Content-Type', 'text/xml'); |
|||
meta.set('Breaking-Bad', '<3'); |
|||
const headers = new Headers(meta); |
|||
const copyOfHeaders = new Headers(headers); |
|||
``` |
|||
|
|||
<a id="iface-body"></a> |
|||
### Interface: Body |
|||
|
|||
`Body` is an abstract interface with methods that are applicable to both `Request` and `Response` classes. |
|||
|
|||
The following methods are not yet implemented in node-fetch at this moment: |
|||
|
|||
- `formData()` |
|||
|
|||
#### body.body |
|||
|
|||
<small>*(deviation from spec)*</small> |
|||
|
|||
* Node.js [`Readable` stream][node-readable] |
|||
|
|||
Data are encapsulated in the `Body` object. Note that while the [Fetch Standard][whatwg-fetch] requires the property to always be a WHATWG `ReadableStream`, in node-fetch it is a Node.js [`Readable` stream][node-readable]. |
|||
|
|||
#### body.bodyUsed |
|||
|
|||
<small>*(spec-compliant)*</small> |
|||
|
|||
* `Boolean` |
|||
|
|||
A boolean property for if this body has been consumed. Per the specs, a consumed body cannot be used again. |
|||
|
|||
#### body.arrayBuffer() |
|||
#### body.blob() |
|||
#### body.json() |
|||
#### body.text() |
|||
|
|||
<small>*(spec-compliant)*</small> |
|||
|
|||
* Returns: <code>Promise</code> |
|||
|
|||
Consume the body and return a promise that will resolve to one of these formats. |
|||
|
|||
#### body.buffer() |
|||
|
|||
<small>*(node-fetch extension)*</small> |
|||
|
|||
* Returns: <code>Promise<Buffer></code> |
|||
|
|||
Consume the body and return a promise that will resolve to a Buffer. |
|||
|
|||
#### body.textConverted() |
|||
|
|||
<small>*(node-fetch extension)*</small> |
|||
|
|||
* Returns: <code>Promise<String></code> |
|||
|
|||
Identical to `body.text()`, except instead of always converting to UTF-8, encoding sniffing will be performed and text converted to UTF-8 if possible. |
|||
|
|||
(This API requires an optional dependency of the npm package [encoding](https://www.npmjs.com/package/encoding), which you need to install manually. `webpack` users may see [a warning message](https://github.com/bitinn/node-fetch/issues/412#issuecomment-379007792) due to this optional dependency.) |
|||
|
|||
<a id="class-fetcherror"></a> |
|||
### Class: FetchError |
|||
|
|||
<small>*(node-fetch extension)*</small> |
|||
|
|||
An operational error in the fetching process. See [ERROR-HANDLING.md][] for more info. |
|||
|
|||
<a id="class-aborterror"></a> |
|||
### Class: AbortError |
|||
|
|||
<small>*(node-fetch extension)*</small> |
|||
|
|||
An Error thrown when the request is aborted in response to an `AbortSignal`'s `abort` event. It has a `name` property of `AbortError`. See [ERROR-HANDLING.MD][] for more info. |
|||
|
|||
## Acknowledgement |
|||
|
|||
Thanks to [github/fetch](https://github.com/github/fetch) for providing a solid implementation reference. |
|||
|
|||
`node-fetch` v1 was maintained by [@bitinn](https://github.com/bitinn); v2 was maintained by [@TimothyGu](https://github.com/timothygu), [@bitinn](https://github.com/bitinn) and [@jimmywarting](https://github.com/jimmywarting); v2 readme is written by [@jkantr](https://github.com/jkantr). |
|||
|
|||
## License |
|||
|
|||
MIT |
|||
|
|||
[npm-image]: https://flat.badgen.net/npm/v/node-fetch |
|||
[npm-url]: https://www.npmjs.com/package/node-fetch |
|||
[travis-image]: https://flat.badgen.net/travis/bitinn/node-fetch |
|||
[travis-url]: https://travis-ci.org/bitinn/node-fetch |
|||
[codecov-image]: https://flat.badgen.net/codecov/c/github/bitinn/node-fetch/master |
|||
[codecov-url]: https://codecov.io/gh/bitinn/node-fetch |
|||
[install-size-image]: https://flat.badgen.net/packagephobia/install/node-fetch |
|||
[install-size-url]: https://packagephobia.now.sh/result?p=node-fetch |
|||
[discord-image]: https://img.shields.io/discord/619915844268326952?color=%237289DA&label=Discord&style=flat-square |
|||
[discord-url]: https://discord.gg/Zxbndcm |
|||
[opencollective-image]: https://opencollective.com/node-fetch/backers.svg |
|||
[opencollective-url]: https://opencollective.com/node-fetch |
|||
[whatwg-fetch]: https://fetch.spec.whatwg.org/ |
|||
[response-init]: https://fetch.spec.whatwg.org/#responseinit |
|||
[node-readable]: https://nodejs.org/api/stream.html#stream_readable_streams |
|||
[mdn-headers]: https://developer.mozilla.org/en-US/docs/Web/API/Headers |
|||
[LIMITS.md]: https://github.com/bitinn/node-fetch/blob/master/LIMITS.md |
|||
[ERROR-HANDLING.md]: https://github.com/bitinn/node-fetch/blob/master/ERROR-HANDLING.md |
|||
[UPGRADE-GUIDE.md]: https://github.com/bitinn/node-fetch/blob/master/UPGRADE-GUIDE.md |
@ -0,0 +1,25 @@ |
|||
"use strict"; |
|||
|
|||
// ref: https://github.com/tc39/proposal-global
|
|||
var getGlobal = function () { |
|||
// the only reliable means to get the global object is
|
|||
// `Function('return this')()`
|
|||
// However, this causes CSP violations in Chrome apps.
|
|||
if (typeof self !== 'undefined') { return self; } |
|||
if (typeof window !== 'undefined') { return window; } |
|||
if (typeof global !== 'undefined') { return global; } |
|||
throw new Error('unable to locate global object'); |
|||
} |
|||
|
|||
var global = getGlobal(); |
|||
|
|||
module.exports = exports = global.fetch; |
|||
|
|||
// Needed for TypeScript and Webpack.
|
|||
if (global.fetch) { |
|||
exports.default = global.fetch.bind(global); |
|||
} |
|||
|
|||
exports.Headers = global.Headers; |
|||
exports.Request = global.Request; |
|||
exports.Response = global.Response; |
1640
node_modules/node-fetch/lib/index.es.js
File diff suppressed because it is too large
View File
File diff suppressed because it is too large
View File
1649
node_modules/node-fetch/lib/index.js
File diff suppressed because it is too large
View File
File diff suppressed because it is too large
View File
1638
node_modules/node-fetch/lib/index.mjs
File diff suppressed because it is too large
View File
File diff suppressed because it is too large
View File
@ -0,0 +1,66 @@ |
|||
{ |
|||
"name": "node-fetch", |
|||
"version": "2.6.1", |
|||
"description": "A light-weight module that brings window.fetch to node.js", |
|||
"main": "lib/index", |
|||
"browser": "./browser.js", |
|||
"module": "lib/index.mjs", |
|||
"files": [ |
|||
"lib/index.js", |
|||
"lib/index.mjs", |
|||
"lib/index.es.js", |
|||
"browser.js" |
|||
], |
|||
"engines": { |
|||
"node": "4.x || >=6.0.0" |
|||
}, |
|||
"scripts": { |
|||
"build": "cross-env BABEL_ENV=rollup rollup -c", |
|||
"prepare": "npm run build", |
|||
"test": "cross-env BABEL_ENV=test mocha --require babel-register --throw-deprecation test/test.js", |
|||
"report": "cross-env BABEL_ENV=coverage nyc --reporter lcov --reporter text mocha -R spec test/test.js", |
|||
"coverage": "cross-env BABEL_ENV=coverage nyc --reporter json --reporter text mocha -R spec test/test.js && codecov -f coverage/coverage-final.json" |
|||
}, |
|||
"repository": { |
|||
"type": "git", |
|||
"url": "https://github.com/bitinn/node-fetch.git" |
|||
}, |
|||
"keywords": [ |
|||
"fetch", |
|||
"http", |
|||
"promise" |
|||
], |
|||
"author": "David Frank", |
|||
"license": "MIT", |
|||
"bugs": { |
|||
"url": "https://github.com/bitinn/node-fetch/issues" |
|||
}, |
|||
"homepage": "https://github.com/bitinn/node-fetch", |
|||
"devDependencies": { |
|||
"@ungap/url-search-params": "^0.1.2", |
|||
"abort-controller": "^1.1.0", |
|||
"abortcontroller-polyfill": "^1.3.0", |
|||
"babel-core": "^6.26.3", |
|||
"babel-plugin-istanbul": "^4.1.6", |
|||
"babel-preset-env": "^1.6.1", |
|||
"babel-register": "^6.16.3", |
|||
"chai": "^3.5.0", |
|||
"chai-as-promised": "^7.1.1", |
|||
"chai-iterator": "^1.1.1", |
|||
"chai-string": "~1.3.0", |
|||
"codecov": "^3.3.0", |
|||
"cross-env": "^5.2.0", |
|||
"form-data": "^2.3.3", |
|||
"is-builtin-module": "^1.0.0", |
|||
"mocha": "^5.0.0", |
|||
"nyc": "11.9.0", |
|||
"parted": "^0.1.1", |
|||
"promise": "^8.0.3", |
|||
"resumer": "0.0.0", |
|||
"rollup": "^0.63.4", |
|||
"rollup-plugin-babel": "^3.0.7", |
|||
"string-to-arraybuffer": "^1.0.2", |
|||
"whatwg-url": "^5.0.0" |
|||
}, |
|||
"dependencies": {} |
|||
} |
@ -0,0 +1,5 @@ |
|||
{ |
|||
"dependencies": { |
|||
"node-fetch": "^2.6.1" |
|||
} |
|||
} |
@ -0,0 +1,8 @@ |
|||
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. |
|||
# yarn lockfile v1 |
|||
|
|||
|
|||
[email protected]^2.6.1: |
|||
version "2.6.1" |
|||
resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.1.tgz#045bd323631f76ed2e2b55573394416b639a0052" |
|||
integrity sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw== |
Write
Preview
Loading…
Cancel
Save
Reference in new issue