got 11.0.0-beta.1 → 11.0.3

package/dist/source/core/utils/get-body-size.d.ts

@@ -1,8 +1,5 @@
+/// <reference path="timed-out.d.ts" />
 /// <reference types="node" />
-import { ClientRequestArgs } from 'http';
-interface Options {
-    body?: unknown;
-    headers: ClientRequestArgs['headers'];
-}
-declare const _default: (options: Options) => Promise<number | undefined>;
+/// <reference types="node/http" />
+declare const _default: (body: unknown, headers: import("http").OutgoingHttpHeaders | undefined) => Promise<number | undefined>;
 export default _default;

package/dist/source/core/utils/get-body-size.js

@@ -5,8 +5,7 @@ const util_1 = require("util");
 const is_1 = require("@sindresorhus/is");
 const is_form_data_1 = require("./is-form-data");
 const statAsync = util_1.promisify(fs_1.stat);
-exports.default = async (options) => {
-    const { body, headers } = options;
+exports.default = async (body, headers) => {
     if (headers && 'content-length' in headers) {
         return Number(headers['content-length']);
     }

package/dist/source/core/utils/options-to-url.js

@@ -30,7 +30,7 @@ exports.default = (origin, options) => {
         if (!options.protocol) {
             throw new TypeError('No URL protocol specified');
         }
-        origin = `${options.protocol}//${_b = (_a = options.hostname, (_a !== null && _a !== void 0 ? _a : options.host)), (_b !== null && _b !== void 0 ? _b : '')}`;
+        origin = `${options.protocol}//${(_b = (_a = options.hostname) !== null && _a !== void 0 ? _a : options.host) !== null && _b !== void 0 ? _b : ''}`;
     }
     const url = new url_1.URL(origin);
     if (options.path) {

package/dist/source/core/utils/timed-out.js

@@ -21,9 +21,9 @@ exports.default = (request, delays, options) => {
     const cancelers = [];
     const { once, unhandleAll } = unhandle_1.default();
     const addTimeout = (delay, callback, event) => {
-        var _a, _b;
+        var _a;
         const timeout = setTimeout(callback, delay, delay, event);
-        (_b = (_a = timeout).unref) === null || _b === void 0 ? void 0 : _b.call(_a);
+        (_a = timeout.unref) === null || _a === void 0 ? void 0 : _a.call(timeout);
         const cancel = () => {
             clearTimeout(timeout);
         };
@@ -32,9 +32,6 @@ exports.default = (request, delays, options) => {
     };
     const { host, hostname } = options;
     const timeoutHandler = (delay, event) => {
-        if (request.socket) {
-            request.socket._hadError = true;
-        }
         request.destroy(new TimeoutError(delay, event));
     };
     const cancelTimeouts = () => {
@@ -46,6 +43,7 @@ exports.default = (request, delays, options) => {
     request.once('error', error => {
         cancelTimeouts();
         // Save original behavior
+        /* istanbul ignore next */
         if (request.listenerCount('error') === 0) {
             throw error;
         }
@@ -74,7 +72,7 @@ exports.default = (request, delays, options) => {
         const { socketPath } = request;
         /* istanbul ignore next: hard to test */
         if (socket.connecting) {
-            const hasPath = Boolean((socketPath !== null && socketPath !== void 0 ? socketPath : net.isIP((_a = (hostname !== null && hostname !== void 0 ? hostname : host), (_a !== null && _a !== void 0 ? _a : ''))) !== 0));
+            const hasPath = Boolean(socketPath !== null && socketPath !== void 0 ? socketPath : net.isIP((_a = hostname !== null && hostname !== void 0 ? hostname : host) !== null && _a !== void 0 ? _a : '') !== 0);
             if (typeof delays.lookup !== 'undefined' && !hasPath && typeof socket.address().address === 'undefined') {
                 const cancelTimeout = addTimeout(delays.lookup, timeoutHandler, 'lookup');
                 once(socket, 'lookup', cancelTimeout);

package/dist/source/core/utils/weakable-map.d.ts

@@ -0,0 +1,8 @@
+export default class WeakableMap<K, V> {
+    weakMap: WeakMap<object, V>;
+    map: Map<K, V>;
+    constructor();
+    set(key: K, value: V): void;
+    get(key: K): V | undefined;
+    has(key: K): boolean;
+}

package/dist/source/core/utils/weakable-map.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class WeakableMap {
+    constructor() {
+        this.weakMap = new WeakMap();
+        this.map = new Map();
+    }
+    set(key, value) {
+        if (typeof key === 'object') {
+            this.weakMap.set(key, value);
+        }
+        else {
+            this.map.set(key, value);
+        }
+    }
+    get(key) {
+        if (typeof key === 'object') {
+            return this.weakMap.get(key);
+        }
+        return this.map.get(key);
+    }
+    has(key) {
+        if (typeof key === 'object') {
+            return this.weakMap.has(key);
+        }
+        return this.map.has(key);
+    }
+}
+exports.default = WeakableMap;

package/dist/source/create.js

@@ -60,8 +60,8 @@ const create = (defaults) => {
         }
         return result;
     }));
-    const got = ((url, options = {}) => {
-        var _a, _b, _c, _d, _e;
+    const got = ((url, options) => {
+        var _a, _b;
         let iteration = 0;
         const iterateHandlers = (newOptions) => {
             return defaults.handlers[iteration++](newOptions, iteration === defaults.handlers.length ? getPromiseOrStream : iterateHandlers);
@@ -78,7 +78,7 @@ const create = (defaults) => {
             let initHookError;
             try {
                 callInitHooks(defaults.options.hooks.init, options);
-                callInitHooks((_b = (_a = options) === null || _a === void 0 ? void 0 : _a.hooks) === null || _b === void 0 ? void 0 : _b.init, options);
+                callInitHooks((_a = options === null || options === void 0 ? void 0 : options.hooks) === null || _a === void 0 ? void 0 : _a.init, options);
             }
             catch (error) {
                 initHookError = error;
@@ -94,13 +94,13 @@ const create = (defaults) => {
             return iterateHandlers(normalizedOptions);
         }
         catch (error) {
-            if ((_c = options) === null || _c === void 0 ? void 0 : _c.isStream) {
+            if (options === null || options === void 0 ? void 0 : options.isStream) {
                 throw error;
             }
             else {
                 // A bug.
                 // eslint-disable-next-line @typescript-eslint/return-await
-                return create_rejection_1.default(error, defaults.options.hooks.beforeError, (_e = (_d = options) === null || _d === void 0 ? void 0 : _d.hooks) === null || _e === void 0 ? void 0 : _e.beforeError);
+                return create_rejection_1.default(error, defaults.options.hooks.beforeError, (_b = options === null || options === void 0 ? void 0 : options.hooks) === null || _b === void 0 ? void 0 : _b.beforeError);
             }
         }
     });
@@ -140,7 +140,8 @@ const create = (defaults) => {
             throw new TypeError('`options.pagination` must be implemented');
         }
         const all = [];
-        while (true) {
+        let numberOfRequests = 0;
+        while (numberOfRequests < pagination.requestLimit) {
             // TODO: Throw when result is not an instance of Response
             // eslint-disable-next-line no-await-in-loop
             const result = (await got('', normalizedOptions));
@@ -167,6 +168,7 @@ const create = (defaults) => {
             if (optionsToMerge !== undefined) {
                 normalizedOptions = normalizeArguments(undefined, optionsToMerge, normalizedOptions);
             }
+            numberOfRequests++;
         }
     });
     got.paginate.all = (async (url, options) => {

package/dist/source/index.js

@@ -104,7 +104,8 @@ const defaults = {
             },
             filter: () => true,
             shouldContinue: () => true,
-            countLimit: Infinity
+            countLimit: Infinity,
+            requestLimit: 10000
         }
     },
     handlers: [create_1.defaultHandler],

package/dist/source/types.d.ts

@@ -17,22 +17,25 @@ export interface ExtendOptions extends Options {
     handlers?: HandlerFunction[];
     mutableDefaults?: boolean;
 }
-export declare type OptionsOfTextResponseBody = Options & {
+export declare type OptionsOfTextResponseBody = Merge<Options, {
     isStream?: false;
     resolveBodyOnly?: false;
     responseType?: 'text';
-};
-export declare type OptionsOfJSONResponseBody = Options & {
+}>;
+export declare type OptionsOfJSONResponseBody = Merge<Options, {
     isStream?: false;
     resolveBodyOnly?: false;
     responseType: 'json';
-};
-export declare type OptionsOfBufferResponseBody = Options & {
+}>;
+export declare type OptionsOfBufferResponseBody = Merge<Options, {
     isStream?: false;
     resolveBodyOnly?: false;
     responseType: 'buffer';
-};
+}>;
 export declare type StrictOptions = Except<Options, 'isStream' | 'responseType' | 'resolveBodyOnly'>;
+export declare type StreamOptions = Merge<Options, {
+    isStream?: true;
+}>;
 declare type ResponseBodyOnly = {
     resolveBodyOnly: true;
 };
@@ -50,29 +53,29 @@ export interface GotRequestFunction {
     (options: OptionsOfTextResponseBody): CancelableRequest<Response<string>>;
     <T>(options: OptionsOfJSONResponseBody): CancelableRequest<Response<T>>;
     (options: OptionsOfBufferResponseBody): CancelableRequest<Response<Buffer>>;
-    (url: string | URL, options?: (OptionsOfTextResponseBody & ResponseBodyOnly)): CancelableRequest<string>;
-    <T>(url: string | URL, options?: (OptionsOfJSONResponseBody & ResponseBodyOnly)): CancelableRequest<T>;
-    (url: string | URL, options?: (OptionsOfBufferResponseBody & ResponseBodyOnly)): CancelableRequest<Buffer>;
-    (options: (OptionsOfTextResponseBody & ResponseBodyOnly)): CancelableRequest<string>;
-    <T>(options: (OptionsOfJSONResponseBody & ResponseBodyOnly)): CancelableRequest<T>;
-    (options: (OptionsOfBufferResponseBody & ResponseBodyOnly)): CancelableRequest<Buffer>;
-    (url: string | URL, options?: Options & {
+    (url: string | URL, options?: (Merge<OptionsOfTextResponseBody, ResponseBodyOnly>)): CancelableRequest<string>;
+    <T>(url: string | URL, options?: (Merge<OptionsOfJSONResponseBody, ResponseBodyOnly>)): CancelableRequest<T>;
+    (url: string | URL, options?: (Merge<OptionsOfBufferResponseBody, ResponseBodyOnly>)): CancelableRequest<Buffer>;
+    (options: (Merge<OptionsOfTextResponseBody, ResponseBodyOnly>)): CancelableRequest<string>;
+    <T>(options: (Merge<OptionsOfJSONResponseBody, ResponseBodyOnly>)): CancelableRequest<T>;
+    (options: (Merge<OptionsOfBufferResponseBody, ResponseBodyOnly>)): CancelableRequest<Buffer>;
+    (url: string | URL, options?: Merge<Options, {
         isStream: true;
-    }): Request;
-    (options: Options & {
+    }>): Request;
+    (options: Merge<Options, {
         isStream: true;
-    }): Request;
+    }>): Request;
     (url: string | URL, options?: Options): CancelableRequest | Request;
     (options: Options): CancelableRequest | Request;
 }
 export declare type HTTPAlias = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete';
 interface GotStreamFunction {
-    (url: string | URL, options?: Options & {
+    (url: string | URL, options?: Merge<Options, {
         isStream?: true;
-    }): Request;
-    (options?: Options & {
+    }>): Request;
+    (options?: Merge<Options, {
         isStream?: true;
-    }): Request;
+    }>): Request;
 }
 export declare type GotStream = GotStreamFunction & Record<HTTPAlias, GotStreamFunction>;
 export interface Got extends Record<HTTPAlias, GotRequestFunction>, GotRequestFunction {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "got",
-	"version": "11.0.0-beta.1",
+	"version": "11.0.3",
 	"description": "Human-friendly and powerful HTTP request library for Node.js",
 	"license": "MIT",
 	"repository": "sindresorhus/got",
@@ -51,7 +51,7 @@
 		"cacheable-request": "^7.0.1",
 		"decompress-response": "^5.0.0",
 		"get-stream": "^5.0.0",
-		"http2-wrapper": "^1.0.0-beta.4.3",
+		"http2-wrapper": "^1.0.0-beta.4.4",
 		"lowercase-keys": "^2.0.0",
 		"p-cancelable": "^2.0.0",
 		"responselike": "^2.0.0"
@@ -66,9 +66,7 @@
 		"@types/node-fetch": "^2.5.5",
 		"@types/request": "^2.48.4",
 		"@types/sinon": "^9.0.0",
-		"@types/tough-cookie": "^2.3.5",
-		"@typescript-eslint/eslint-plugin": "^2.27.0",
-		"@typescript-eslint/parser": "^2.27.0",
+		"@types/tough-cookie": "^4.0.0",
 		"ava": "^3.6.0",
 		"axios": "^0.19.2",
 		"benchmark": "^2.1.4",
@@ -76,7 +74,6 @@
 		"create-test-server": "^3.0.1",
 		"del-cli": "^3.0.0",
 		"delay": "^4.3.0",
-		"eslint-config-xo-typescript": "^0.27.0",
 		"express": "^4.17.1",
 		"form-data": "^3.0.0",
 		"lolex": "^6.0.0",
@@ -89,9 +86,9 @@
 		"slow-stream": "0.0.4",
 		"tempy": "^0.5.0",
 		"to-readable-stream": "^2.1.0",
-		"tough-cookie": "^3.0.0",
-		"typescript": "3.7.5",
-		"xo": "^0.29.0"
+		"tough-cookie": "^4.0.0",
+		"typescript": "3.8.3",
+		"xo": "^0.30.0"
 	},
 	"types": "dist/source",
 	"sideEffects": false,
@@ -115,10 +112,6 @@
 		]
 	},
 	"xo": {
-		"extends": "xo-typescript",
-		"extensions": [
-			"ts"
-		],
 		"ignores": [
 			"documentation/examples/*"
 		],
@@ -127,11 +120,10 @@
 			"@typescript-eslint/no-base-to-string": "off",
 			"node/prefer-global/url": "off",
 			"node/prefer-global/url-search-params": "off",
-			"unicorn/string-content": "off",
 			"@typescript-eslint/prefer-readonly-parameter-types": "off",
-			"@typescript-eslint/no-unsafe-member-access": "off",
-			"@typescript-eslint/no-unsafe-call": "off",
-			"@typescript-eslint/no-unsafe-return": "off"
+			"@typescript-eslint/no-floating-promises": "off",
+			"@typescript-eslint/method-signature-style": "off",
+			"unicorn/no-fn-reference-in-iterator": "off"
 		}
 	}
 }

package/readme.md

@@ -56,6 +56,8 @@ $ npm install got
 
 ## Usage
 
+###### Promise
+
 ```js
 const got = require('got');
 
@@ -71,6 +73,26 @@ const got = require('got');
 })();
 ```
 
+###### JSON
+
+```js
+const got = require('got');
+
+(async () => {
+	const {body} = await got.post('https://httpbin.org/anything', {
+		json: {
+			hello: 'world'
+		},
+		responseType: 'json'
+	});
+
+	console.log(body.data);
+	//=> {hello: 'world'}
+})();
+```
+
+See [JSON mode](#json-mode) for more details.
+
 ###### Streams
 
 ```js
@@ -452,14 +474,14 @@ If this is disabled, a compressed response is returned as a `Buffer`. This may b
 
 ###### cache
 
-Type: `object`\
+Type: `object | false`\
 Default: `false`
 
 [Cache adapter instance](#cache-adapters) for storing cached response data.
 
 ###### dnsCache
 
-Type: `object`\
+Type: `object | false`\
 Default: `new CacheableLookup()`
 
 An instance of [`CacheableLookup`](https://github.com/szmarczak/cacheable-lookup) used for making DNS lookups.
@@ -760,6 +782,15 @@ Default: `Infinity`
 
 The maximum amount of items that should be emitted.
 
+###### pagination.requestLimit
+
+Type: `number`\
+Default: `10000`
+
+The maximum amount of request that should be triggered. [Retries on failure](#retry) are not counted towards this limit.
+
+For example, it can be helpful during development to avoid an infinite number of requests.
+
 ##### localAddress
 
 Type: `string`
@@ -784,6 +815,12 @@ Type: `string | object | Buffer` *(Depending on `options.responseType`)*
 
 The result of the request.
 
+##### rawBody
+
+Type: `Buffer`
+
+The raw result of the request.
+
 ##### url
 
 Type: `string`
@@ -934,6 +971,10 @@ The same as `response.timings`.
 
 The same as `response.isFromCache`.
 
+##### .socket
+
+The same as `response.socket`.
+
 ##### .on('error', error)
 
 The emitted `error` is an instance of [`RequestError`](#got.requesterror).
@@ -962,6 +1003,25 @@ Returns an async iterator:
 
 See [`options.pagination`](#pagination) for more pagination options.
 
+#### got.paginate.all(url, options?)
+
+Returns a Promise for an array of all results:
+
+```js
+(async () => {
+	const countLimit = 10;
+
+	const results = await got.paginate.all('https://api.github.com/repos/sindresorhus/got/commits', {
+		pagination: {countLimit}
+	});
+
+	console.log(`Printing latest ${countLimit} Got commits (newest to oldest):`);
+	console.log(results);
+})();
+```
+
+See [`options.pagination`](#pagination) for more pagination options.
+
 #### got.get(url, options?)
 #### got.post(url, options?)
 #### got.put(url, options?)
@@ -1039,7 +1099,7 @@ const mergedHandlers = got.extend({
 
 ```js
 const handler = (options, next) => {
-	if (options.stream) {
+	if (options.isStream) {
 		// It's a Stream
 		return next(options);
 	}
@@ -1186,10 +1246,10 @@ Got exports some handy TypeScript types and interfaces. See the type definition
 TypeScript will automatically infer types for Got instances, but in case you want to define something like dependencies, you can import the available types directly from Got.
 
 ```ts
-import {GotRequestMethod} from 'got';
+import {GotRequestFunction} from 'got';
 
 interface Dependencies {
-	readonly post: GotRequestMethod
+	readonly post: GotRequestFunction
 }
 ```
 
@@ -1311,7 +1371,7 @@ stream.destroy();
 <a name="cache-adapters"></a>
 ## Cache
 
-Got implements [RFC 7234](http://httpwg.org/specs/rfc7234.html) compliant HTTP caching which works out of the box in-memory and is easily pluggable with a wide range of storage adapters. Fresh cache entries are served directly from the cache, and stale cache entries are revalidated with `If-None-Match`/`If-Modified-Since` headers. You can read more about the underlying cache behavior in the [`cacheable-request` documentation](https://github.com/lukechilds/cacheable-request). For DNS cache, Got uses [`cacheable-lookup`](https://github.com/szmarczak/cacheable-lookup).
+Got implements [RFC 7234](https://httpwg.org/specs/rfc7234.html) compliant HTTP caching which works out of the box in-memory and is easily pluggable with a wide range of storage adapters. Fresh cache entries are served directly from the cache, and stale cache entries are revalidated with `If-None-Match`/`If-Modified-Since` headers. You can read more about the underlying cache behavior in the [`cacheable-request` documentation](https://github.com/lukechilds/cacheable-request). For DNS cache, Got uses [`cacheable-lookup`](https://github.com/szmarczak/cacheable-lookup).
 
 You can use the JavaScript `Map` type as an in-memory cache:
 
@@ -1372,11 +1432,13 @@ const got = require('got');
 const tunnel = require('tunnel');
 
 got('https://sindresorhus.com', {
-	agent: tunnel.httpOverHttp({
-		proxy: {
-			host: 'localhost'
-		}
-	})
+	agent: {
+		https: tunnel.httpOverHttp({
+			proxy: {
+				host: 'localhost'
+			}
+		})
+	}
 });
 ```
 
@@ -1674,7 +1736,7 @@ The Electron `net` module is not consistent with the Node.js `http` module. See
 <!-- GITHUB -->
 [k0]: https://github.com/sindresorhus/ky
 [r0]: https://github.com/request/request
-[n0]: https://github.com/bitinn/node-fetch
+[n0]: https://github.com/node-fetch/node-fetch
 [a0]: https://github.com/axios/axios
 [s0]: https://github.com/visionmedia/superagent