node-fetch - npm Package Compare versions

Comparing version 2.6.0 to 3.0.0-beta.1

package.json

 {
-  "name": "node-fetch",
-  "version": "2.6.0",
-  "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": {}
+    "name": "node-fetch",
+    "version": "3.0.0-beta.1",
+    "description": "A light-weight module that brings window.fetch to node.js",
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "types": "types/index.d.ts",
+    "files": [
+        "src/**/*",
+        "dist/**/*",
+        "types/**/*.d.ts"
+    ],
+    "engines": {
+        "node": ">=10.0.0"
+    },
+    "scripts": {
+        "build": "pika-pack --out dist/",
+        "prepare": "npm run build",
+        "prepublishOnly": "npm run build",
+        "test": "cross-env BABEL_ENV=test mocha --require @babel/register --throw-deprecation test/*.js",
+        "report": "cross-env BABEL_ENV=coverage nyc --reporter lcov --reporter text mocha -R spec test/*.js",
+        "coverage": "cross-env BABEL_ENV=coverage nyc --reporter json --reporter text mocha -R spec test/*.js && codecov -f coverage/coverage-final.json",
+        "lint": "xo"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/node-fetch/node-fetch.git"
+    },
+    "keywords": [
+        "fetch",
+        "http",
+        "promise"
+    ],
+    "author": "David Frank",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/node-fetch/node-fetch/issues"
+    },
+    "homepage": "https://github.com/node-fetch/node-fetch",
+    "funding": {
+        "type": "opencollective",
+        "url": "https://opencollective.com/node-fetch"
+    },
+    "devDependencies": {
+        "@babel/core": "^7.8.7",
+        "@babel/preset-env": "^7.8.7",
+        "@babel/register": "^7.8.6",
+        "@pika/pack": "^0.5.0",
+        "@pika/plugin-build-node": "^0.9.2",
+        "@pika/plugin-build-types": "^0.9.2",
+        "@pika/plugin-copy-assets": "^0.9.2",
+        "@pika/plugin-standard-pkg": "^0.9.2",
+        "abort-controller": "^3.0.0",
+        "abortcontroller-polyfill": "^1.4.0",
+        "chai": "^4.2.0",
+        "chai-as-promised": "^7.1.1",
+        "chai-iterator": "^3.0.2",
+        "chai-string": "^1.5.0",
+        "codecov": "^3.6.5",
+        "cross-env": "^7.0.2",
+        "form-data": "^3.0.0",
+        "mocha": "^7.1.0",
+        "nyc": "^15.0.0",
+        "parted": "^0.1.1",
+        "promise": "^8.1.0",
+        "resumer": "0.0.0",
+        "string-to-arraybuffer": "^1.0.2",
+        "xo": "^0.28.0"
+    },
+    "dependencies": {
+        "data-uri-to-buffer": "^3.0.0",
+        "fetch-blob": "^1.0.5"
+    },
+    "@pika/pack": {
+        "pipeline": [
+            [
+                "@pika/plugin-standard-pkg"
+            ],
+            [
+                "@pika/plugin-build-node"
+            ],
+            [
+                "@pika/plugin-build-types"
+            ],
+            [
+                "@pika/plugin-copy-assets",
+                {
+                    "files": [
+                        "externals.d.ts"
+                    ]
+                }
+            ]
+        ]
+    },
+    "xo": {
+        "envs": [
+            "node",
+            "browser"
+        ],
+        "rules": {
+            "complexity": 0,
+            "promise/prefer-await-to-then": 0,
+            "no-mixed-operators": 0,
+            "no-negated-condition": 0,
+            "unicorn/prevent-abbreviations": 0
+        },
+        "ignores": [
+            "dist"
+        ],
+        "overrides": [
+            {
+                "files": "test/**/*.js",
+                "envs": [
+                    "node",
+                    "mocha"
+                ],
+                "rules": {
+                    "max-nested-callbacks": 0,
+                    "no-unused-expressions": 0,
+                    "new-cap": 0,
+                    "guard-for-in": 0
+                }
+            },
+            {
+                "files": "example.js",
+                "rules": {
+                    "import/no-extraneous-dependencies": 0
+                }
+            }
+        ]
+    },
+    "babel": {
+        "presets": [
+            [
+                "@babel/preset-env",
+                {
+                    "targets": {
+                        "node": true
+                    }
+                }
+            ]
+        ]
+    },
+    "nyc": {
+        "require": [
+            "@babel/register"
+        ],
+        "sourceMap": false,
+        "instrument": false
+    },
+    "runkitExampleFilename": "example.js"
 }

README.md

@@ -1,13 +0,23 @@
-node-fetch
-==========
+<div align="center">
+  	<img src="docs/media/Banner.svg" alt="Node Fetch"/>
+  	<br>
+  	<p>A light-weight module that brings <code>window.fetch</code> to Node.js.</p>
+	<a href="https://travis-ci.com/node-fetch/node-fetch"><img src="https://img.shields.io/travis/com/node-fetch/node-fetch/master?style=flat-square" alt="Build status"></a>
+	<a href="https://codecov.io/gh/node-fetch/node-fetch"><img src="https://img.shields.io/codecov/c/gh/node-fetch/node-fetch/master?style=flat-square" alt="Coverage status"></a>
+	<a href="https://packagephobia.now.sh/result?p=node-fetch"><img src="https://flat.badgen.net/packagephobia/install/node-fetch" alt="Current version"></a>
+	<a href="https://www.npmjs.com/package/node-fetch"><img src="https://img.shields.io/npm/v/node-fetch?style=flat-square" alt="Install size"></a>
+	<a href="https://github.com/sindresorhus/awesome-nodejs"><img src="https://awesome.re/mentioned-badge-flat.svg" alt="Mentioned in Awesome Node.js"></a>
+	<a href="https://discord.gg/Zxbndcm"><img src="https://img.shields.io/discord/619915844268326952?color=%237289DA&label=Discord&style=flat-square" alt="Discord"></a>
+	<br>
+	<br>
+	<b>Consider supporting us on our Open Collective:</b>
+	<br>
+	<br>
+	<a href="https://opencollective.com/node-fetch"><img src="https://opencollective.com/node-fetch/donate/button.png?color=blue" alt="Open Collective"></a>
+</div>
 
-[![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]
+---
 
-A light-weight module that brings `window.fetch` to Node.js
+[![Backers][opencollective-image]][opencollective-url]
 
-(We are looking for [v2 maintainers and collaborators](https://github.com/bitinn/node-fetch/issues/567))
-
 <!-- TOC -->
@@ -20,2 +30,3 @@
 - [Loading and configuring the module](#loading-and-configuring-the-module)
+- [Upgrading](#upgrading)
 - [Common Usage](#common-usage)
@@ -40,9 +51,28 @@ - [Plain text or HTML](#plain-text-or-html)
     - [Options](#options)
+        - [Default Headers](#default-headers)
+        - [Custom Agent](#custom-agent)
+        - [Custom highWaterMark](#custom-highwatermark)
     - [Class: Request](#class-request)
+        - [new Request(input[, options])](#new-requestinput-options)
     - [Class: Response](#class-response)
+        - [new Response([body[, options]])](#new-responsebody-options)
+        - [response.ok](#responseok)
+        - [response.redirected](#responseredirected)
     - [Class: Headers](#class-headers)
+        - [new Headers([init])](#new-headersinit)
     - [Interface: Body](#interface-body)
+        - [body.body](#bodybody)
+        - [body.bodyUsed](#bodybodyused)
+        - [body.arrayBuffer()](#bodyarraybuffer)
+        - [body.blob()](#bodyblob)
+        - [body.json()](#bodyjson)
+        - [body.text()](#bodytext)
+        - [body.buffer()](#bodybuffer)
     - [Class: FetchError](#class-fetcherror)
+    - [Class: AbortError](#class-aborterror)
+- [TypeScript](#typescript)
+- [Acknowledgement](#acknowledgement)
+- [Team](#team)
+                - [Former](#former)
 - [License](#license)
-- [Acknowledgement](#acknowledgement)
 
@@ -53,3 +83,3 @@ <!-- /TOC -->
 
-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.
+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.
 
@@ -65,7 +95,9 @@ 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).
 - 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.
+- 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.
+- See known differences:
+	- [As of v3.x](docs/v3-LIMITS.md)
+	- [As of v2.x](docs/v2-LIMITS.md)
 - If you happen to use a missing feature that `window.fetch` offers, feel free to open an issue.
@@ -76,16 +108,22 @@ - Pull requests are welcomed too!
 
-Current stable release (`2.x`)
+Current stable release (`3.x`)
 
 ```sh
-$ npm install node-fetch --save
+$ npm install node-fetch
 ```
 
 ## Loading and configuring the module
-We suggest you load the module via `require`, pending the stabalizing of es modules in node:
+
 ```js
+// CommonJS
 const fetch = require('node-fetch');
+
+// ES Module
+import fetch from 'node-fetch';
 ```
 
-If you are using a Promise library other than native, set it through fetch.Promise:
+If you are using a Promise library other than native, set it through `fetch.Promise`:
+
 ```js
+const fetch = require('node-fetch');
 const Bluebird = require('bluebird');
@@ -96,50 +134,94 @@
 
+If you want to patch the global object in node:
+
+```js
+const fetch = require('node-fetch');
+
+if (!globalThis.fetch) {
+    globalThis.fetch = fetch;
+}
+```
+
+For versions of node earlier than 12.x, use this `globalThis` [polyfill](https://mathiasbynens.be/notes/globalthis):
+
+```js
+(function() {
+	if (typeof globalThis === 'object') return;
+	Object.defineProperty(Object.prototype, '__magic__', {
+		get: function() {
+			return this;
+		},
+		configurable: true
+	});
+	__magic__.globalThis = __magic__;
+	delete Object.prototype.__magic__;
+}());
+```
+
+## Upgrading
+
+Using an old version of node-fetch? Check out the following files:
+
+- [2.x to 3.x upgrade guide](docs/v3-UPGRADE-GUIDE.md)
+- [1.x to 2.x upgrade guide](docs/v2-UPGRADE-GUIDE.md)
+- [Changelog](docs/CHANGELOG.md)
+
 ## Common Usage
 
-NOTE: The documentation below is up-to-date with `2.x` releases, [see `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.
+NOTE: The documentation below is up-to-date with `3.x` releases, if you are using an older version, please check how to [upgrade](#upgrading).
 
-#### Plain text or HTML
+### Plain text or HTML
+
 ```js
+const fetch = require('node-fetch');
+
 fetch('https://github.com/')
-    .then(res => res.text())
-    .then(body => console.log(body));
+	.then(res => res.text())
+	.then(body => console.log(body));
 ```
 
-#### JSON
+### JSON
 
 ```js
+const fetch = require('node-fetch');
 
 fetch('https://api.github.com/users/github')
-    .then(res => res.json())
-    .then(json => console.log(json));
+	.then(res => res.json())
+	.then(json => console.log(json));
 ```
 
-#### Simple Post
+### 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));
+const fetch = require('node-fetch');
+
+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
+### Post with JSON
 
 ```js
-const body = { a: 1 };
+const fetch = require('node-fetch');
 
+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));
+	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.
+### Post with form parameters
 
+`URLSearchParams` is available on the global object in Node.js as of v10.0.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 fetch = require('node-fetch');
 
@@ -149,32 +231,38 @@ const params = new URLSearchParams();
 
-fetch('https://httpbin.org/post', { method: 'POST', body: params })
-    .then(res => res.json())
-    .then(json => console.log(json));
+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.
+### Handling exceptions
 
-Adding a catch to the fetch promise chain will catch *all* exceptions, such as errors originating from node core libraries, like network errors, and operational errors which are instances of FetchError. See the [error handling document](ERROR-HANDLING.md)  for more details.
+NOTE: 3xx-5xx responses are _NOT_ exceptions, and should be handled in `then()`, see the next section.
 
+Adding a catch to the fetch promise chain will catch _all_ exceptions, such as errors originating from node core libraries, like 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));
+const fetch = require('node-fetch');
+
+fetch('https://domain.invalid/').catch(err => console.error(err));
 ```
 
-#### Handling client and server errors
+### 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
+const fetch = require('node-fetch');
+
 function checkStatus(res) {
-    if (res.ok) { // res.status >= 200 && res.status < 300
-        return res;
-    } else {
-        throw MyCustomError(res.statusText);
-    }
+	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...'))
+	.then(checkStatus)
+	.then(res => console.log('will not get here...'));
 ```
@@ -184,63 +272,78 @@
 
-#### Streams
+### 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);
-    });
+const {createWriteStream} = require('fs');
+const fetch = require('node-fetch');
+
+fetch(
+	'https://octodex.github.com/images/Fintechtocat.png'
+).then(res => {
+	const dest = fs.createWriteStream('./octocat.png');
+	res.body.pipe(dest);
+});
 ```
 
-#### Buffer
+### Buffer
+
 If you prefer to cache binary data in full, use buffer(). (NOTE: buffer() is a `node-fetch` only API)
 
 ```js
+const fetch = require('node-fetch');
 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 => { /* ... */ });
+fetch('https://octodex.github.com/images/Fintechtocat.png')
+	.then(res => res.buffer())
+	.then(buffer => fileType(buffer))
+	.then(type => {
+		console.log(type);
+	});
 ```
 
-#### Accessing Headers and other Meta data
+### 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'));
-    });
+const fetch = require('node-fetch');
+
+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
+### Extract Set-Cookie Header
 
-Unlike browsers, you can access raw `Set-Cookie` headers manually using `Headers.raw()`, this is a `node-fetch` only API.
+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']);
+const fetch = require('node-fetch');
+
+fetch('https://example.com').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
+### Post data using a file stream
 
 ```js
-const { createReadStream } = require('fs');
+const {createReadStream} = require('fs');
+const fetch = require('node-fetch');
 
 const stream = createReadStream('input.txt');
 
-fetch('https://httpbin.org/post', { method: 'POST', body: stream })
-    .then(res => res.json())
-    .then(json => console.log(json));
+fetch('https://httpbin.org/post', {method: 'POST', body: stream})
+	.then(res => res.json())
+	.then(json => console.log(json));
 ```
 
-#### Post with form-data (detect multipart)
+### Post with form-data (detect multipart)
 
 ```js
+const fetch = require('node-fetch');
 const FormData = require('form-data');
@@ -251,5 +354,5 @@
 
-fetch('https://httpbin.org/post', { method: 'POST', body: form })
-    .then(res => res.json())
-    .then(json => console.log(json));
+fetch('https://httpbin.org/post', {method: 'POST', body: form})
+	.then(res => res.json())
+	.then(json => console.log(json));
 
@@ -259,53 +362,47 @@ // OR, using custom headers
 
-const form = new FormData();
-form.append('a', 1);
-
 const options = {
-    method: 'POST',
-    body: form,
-    headers: form.getHeaders()
-}
+	method: 'POST',
+	body: form,
+	headers: form.getHeaders()
+};
 
 fetch('https://httpbin.org/post', options)
-    .then(res => res.json())
-    .then(json => console.log(json));
+	.then(res => res.json())
+	.then(json => console.log(json));
 ```
 
-#### Request cancellation with AbortSignal
+### Request cancellation with AbortSignal
 
-> NOTE: You may only cancel streamed requests 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 follows:
+An example of timing out a request after 150ms could be achieved as the following:
 
 ```js
-import AbortController from 'abort-controller';
+const fetch = require('node-fetch');
+const AbortController = require('abort-controller');
 
 const controller = new AbortController();
-const timeout = setTimeout(
-  () => { controller.abort(); },
-  150,
-);
+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);
-  });
+fetch('https://example.com', {signal: controller.signal})
+	.then(res => res.json())
+	.then(
+		data => {
+			useData(data);
+		},
+		err => {
+			if (err.name === 'AbortError') {
+                console.log('request was aborted');
+			}
+		}
+	)
+	.finally(() => {
+		clearTimeout(timeout);
+	});
 ```
 
-See [test cases](https://github.com/bitinn/node-fetch/blob/master/test/test.js) for more examples.
+See [test cases](https://github.com/node-fetch/node-fetch/blob/master/test/test.js) for more examples.
 
-
 ## API
@@ -321,5 +418,6 @@
 
-`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.
+`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
@@ -333,34 +431,35 @@
     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
+    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)
+    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)
+    highWaterMark: 16384    // the maximum number of bytes to store in the internal buffer before ceasing to read from the underlying resource.
 }
 ```
 
-##### Default Headers
+#### 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)`
+| 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 (+https://github.com/node-fetch/node-fetch)` |
 
 Note: when `body` is a `Stream`, `Content-Length` is not set automatically.
 
-##### Custom Agent
+#### Custom Agent
 
-The `agent` option allows you to specify networking related options that's out of the scope of Fetch. Including and not limit to:
+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:
 
@@ -373,24 +472,57 @@ - Support self-signed certificate
 
-In addition, `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.
+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 http = require('http');
+const https = require('https');
+
 const httpAgent = new http.Agent({
-    keepAlive: true
+	keepAlive: true
 });
 const httpsAgent = new https.Agent({
-    keepAlive: true
+	keepAlive: true
 });
 
 const options = {
-    agent: function (_parsedURL) {
-        if (_parsedURL.protocol == 'http:') {
-            return httpAgent;
-        } else {
-            return httpsAgent;
-        }
-    }
-}
+	agent: function(_parsedURL) {
+		if (_parsedURL.protocol == 'http:') {
+			return httpAgent;
+		} else {
+			return httpsAgent;
+		}
+	}
+};
 ```
 
+<a id="custom-highWaterMark"></a>
+
+#### Custom highWaterMark
+
+Stream on Node.js have a smaller internal buffer size (16Kb, aka `highWaterMark`) from client-side browsers (>1Mb, not consistent across browsers). Because of that, when you are writing an isomorphic app and using `res.clone()`, it will hang with large response in Node.
+
+The recommended way to fix this problem is to resolve cloned response in parallel:
+
+```js
+const fetch = require('node-fetch');
+
+fetch('https://example.com').then(res => {
+	const r1 = res.clone();
+
+	return Promise.all([res.json(), r1.text()]).then(results => {
+		console.log(results[0]);
+		console.log(results[1]);
+	});
+});
+```
+
+If for some reason you don't like the solution above, since `3.x` you are able to modify the `highWaterMark` option:
+
+```js
+const fetch = require('node-fetch');
+
+fetch('https://example.com', {highWaterMark: 10}).then(res => res.clone().buffer());
+```
+
 <a id="class-request"></a>
+
 ### Class: Request
@@ -418,2 +550,3 @@
 - `agent`
+- `highWaterMark`
 
@@ -424,3 +557,3 @@ See [options](#fetch-options) for exact meaning of these extensions.
 
-<small>*(spec-compliant)*</small>
+<small>_(spec-compliant)_</small>
 
@@ -435,2 +568,3 @@ - `input` A string representing a URL, or another `Request` (which will be cloned)
 <a id="class-response"></a>
+
 ### Class: Response
@@ -449,5 +583,5 @@
 
-<small>*(spec-compliant)*</small>
+<small>_(spec-compliant)_</small>
 
-- `body` A string or [Readable stream][node-readable]
+- `body` A `String` or [`Readable` stream][node-readable]
 - `options` A [`ResponseInit`][response-init] options dictionary
@@ -461,3 +595,3 @@
 
-<small>*(spec-compliant)*</small>
+<small>_(spec-compliant)_</small>
 
@@ -468,3 +602,3 @@ 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.
 
-<small>*(spec-compliant)*</small>
+<small>_(spec-compliant)_</small>
 
@@ -474,2 +608,3 @@ 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
@@ -481,14 +616,15 @@
 
-<small>*(spec-compliant)*</small>
+<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.
+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 Headers = require('node-fetch');
 
 const meta = {
-  'Content-Type': 'text/xml',
-  'Breaking-Bad': '<3'
+	'Content-Type': 'text/xml',
+	'Breaking-Bad': '<3'
 };
@@ -498,6 +634,3 @@ const headers = new Headers(meta);
 // The above is equivalent to
-const meta = [
-  [ 'Content-Type', 'text/xml' ],
-  [ 'Breaking-Bad', '<3' ]
-];
+const meta = [['Content-Type', 'text/xml'], ['Breaking-Bad', '<3']];
 const headers = new Headers(meta);
@@ -514,2 +647,3 @@
 <a id="iface-body"></a>
+
 ### Interface: Body
@@ -525,24 +659,27 @@
 
-<small>*(deviation from spec)*</small>
+<small>_(deviation from spec)_</small>
 
-* Node.js [`Readable` stream][node-readable]
+- Node.js [`Readable` stream][node-readable]
 
-The data 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].
+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>
+<small>_(spec-compliant)_</small>
 
-* `Boolean`
+- `Boolean`
 
-A boolean property for if this body has been consumed. Per spec, a consumed body cannot be used again.
+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>
+<small>_(spec-compliant)_</small>
 
-* Returns: <code>Promise</code>
+- Returns: `Promise`
 
@@ -553,22 +690,13 @@ Consume the body and return a promise that will resolve to one of these formats.
 
-<small>*(node-fetch extension)*</small>
+<small>_(node-fetch extension)_</small>
 
-* Returns: <code>Promise&lt;Buffer&gt;</code>
+- Returns: `Promise<Buffer>`
 
 Consume the body and return a promise that will resolve to a Buffer.
 
-#### body.textConverted()
+<a id="class-fetcherror"></a>
 
-<small>*(node-fetch extension)*</small>
-
-* Returns: <code>Promise&lt;String&gt;</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 on 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>
+<small>_(node-fetch extension)_</small>
 
@@ -578,8 +706,19 @@ 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>
+<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.
 
+## TypeScript
+
+Since `3.x` types are bundled with `node-fetch`, so you don't need to install any additional packages.
+
+For older versions please use the type definitions from [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped):
+
+```sh
+$ npm install --save-dev @types/node-fetch
+```
+
 ## Acknowledgement
@@ -589,4 +728,13 @@
 
-`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).
+## Team
 
+[![David Frank](https://github.com/bitinn.png?size=100)](https://github.com/bitinn) | [![Jimmy Wärting](https://github.com/jimmywarting.png?size=100)](https://github.com/jimmywarting) | [![Antoni Kepinski](https://github.com/xxczaki.png?size=100)](https://github.com/xxczaki) | [![Richie Bendall](https://github.com/Richienb.png?size=100)](https://github.com/Richienb) | [![Gregor Martynus](https://github.com/gr2m.png?size=100)](https://github.com/gr2m)
+---|---|---|---|---
+[David Frank](https://bitinn.net/) | [Jimmy Wärting](https://jimmy.warting.se/) | [Antoni Kepinski](https://kepinski.me) | [Richie Bendall](https://www.richie-bendall.ml/) | [Gregor Martynus](https://twitter.com/gr2m)
+
+###### Former
+
+- [Timothy Gu](https://github.com/timothygu)
+- [Jared Kantrowitz](https://github.com/jkantr)
+
 ## License
@@ -596,10 +744,2 @@
 
-[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
 [whatwg-fetch]: https://fetch.spec.whatwg.org/
@@ -609,4 +749,2 @@ [response-init]: https://fetch.spec.whatwg.org/#responseinit
 [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
+[error-handling.md]: https://github.com/node-fetch/node-fetch/blob/master/docs/ERROR-HANDLING.md

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 2 instances in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

184836

increased by18.32%

Number of package files

26

increased by225%

Number of lines in readme file

722

increased by23.63%

Worsened metrics

Dependency count

2

increased byInfinity%

Lines of code

3425

decreased by-19.35%

Number of medium maintenance alerts

1

increased byInfinity%

Number of low quality alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

36

increased by20%

Dependency changes

• + Addeddata-uri-to-buffer@^3.0.0

• + Addedfetch-blob@^1.0.5

• + Addeddata-uri-to-buffer@3.0.1(transitive)

• + Addedfetch-blob@1.0.7(transitive)