Tweaks

Author: sindresorhus

documentation/2-options.md

@@ -116,11 +116,11 @@ await got('https://httpbin.org/anything');
 await got(new URL('https://httpbin.org/anything'));
 ```
 
-#### **Note:**
-> - Throws if no protocol specified.
+> [!NOTE]
+> Throws if no protocol specified.
 
-#### **Note:**
-> - If `url` is a string, then the `query` string will **not** be parsed as search params.\
+> [!NOTE]
+> If `url` is a string, then the `query` string will **not** be parsed as search params.\
 >  This is in accordance to [the specification](https://datatracker.ietf.org/doc/html/rfc7230#section-2.7).\
 >  If you want to pass search params instead, use the `searchParams` option below.
 
@@ -134,8 +134,8 @@ await got('https://httpbin.org/anything', {searchParams: {query: 'a b'}}); //=>
 await got('https://httpbin.org/anything?query=a b', {searchParams: {query: 'a b'}}); //=> ?query=a+b
 ```
 
-#### **Note:**
-> - Leading slashes are disallowed to enforce consistency and avoid confusion.\
+> [!NOTE]
+> Leading slashes are disallowed to enforce consistency and avoid confusion.\
 >  For example, when the prefix URL is `https://example.com/foo` and the input is `/bar`, there's ambiguity whether the resulting URL would become `https://example.com/foo/bar` or `https://example.com/bar`. The latter is used by browsers.
 
 ### `searchParams`
@@ -171,10 +171,10 @@ console.log(searchParams.toString());
 //=> 'key=a&key=b'
 ```
 
-#### **Note:**
-> - This will override the `query` string in `url`.
+> [!NOTE]
+> This will override the `query` string in `url`.
 
-#### **Note:**
+> [!NOTE]
 > - `null` values are not stringified, an empty string is used instead.
 > - `undefined` values will clear the original keys.
 
@@ -202,11 +202,11 @@ await instance('anything');
 await got('https://httpbin.org/anything');
 ```
 
-#### **Note:**
-> - Changing `prefixUrl` also updates the `url` option if set.
+> [!NOTE]
+> Changing `prefixUrl` also updates the `url` option if set.
 
-#### **Note:**
-> - If you're passing an absolute URL as `url`, you need to set `prefixUrl` to an empty string.
+> [!NOTE]
+> If you're passing an absolute URL as `url`, you need to set `prefixUrl` to an empty string.
 
 ### `signal`
 
@@ -357,17 +357,17 @@ console.log(data.form.greeting);
 //=> 'Hello, world!'
 ```
 
-#### **Note:**
-> - If `body` is specified, then the `json` or `form` option cannot be used.
+> [!NOTE]
+> If `body` is specified, then the `json` or `form` option cannot be used.
 
-#### **Note:**
-> - If you use this option, `got.stream()` will be read-only.
+> [!NOTE]
+> If you use this option, `got.stream()` will be read-only.
 
-#### **Note:**
-> - Passing `body` with `GET` will throw unless the [`allowGetBody` option](#allowgetbody) is set to `true`.
+> [!NOTE]
+> Passing `body` with `GET` will throw unless the [`allowGetBody` option](#allowgetbody) is set to `true`.
 
-#### **Note:**
-> - This option is not enumerable and will not be merged with the instance defaults.
+> [!NOTE]
+> This option is not enumerable and will not be merged with the instance defaults.
 
 ### `json`
 
@@ -491,11 +491,11 @@ However, the [HTTP/2 specification](https://datatracker.ietf.org/doc/html/rfc754
 
 Therefore this option has no effect when using HTTP/2.
 
-#### **Note:**
-> - This option is only meant to interact with non-compliant servers when you have no other choice.
+> [!NOTE]
+> This option is only meant to interact with non-compliant servers when you have no other choice.
 
-#### **Note:**
-> - The [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) doesn't specify any particular behavior for the GET method having a payload, therefore it's considered an [**anti-pattern**](https://en.wikipedia.org/wiki/Anti-pattern).
+> [!NOTE]
+> The [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) doesn't specify any particular behavior for the GET method having a payload, therefore it's considered an [**anti-pattern**](https://en.wikipedia.org/wiki/Anti-pattern).
 
 ### `copyPipedHeaders`
 
@@ -630,11 +630,11 @@ const [response, buffer, json] = await Promise.all([responsePromise, bufferPromi
 // `json` is an object
 ```
 
-#### **Note:**
-> - When using streams, this option is ignored.
+> [!NOTE]
+> When using streams, this option is ignored.
 
-#### **Note:**
-> - `'buffer'` will return the raw body bytes as a `Uint8Array`. Any modifications will also alter the result of `.text()` and `.json()`. Before overwriting it, please copy it first via `new Uint8Array(buffer)`.\
+> [!NOTE]
+> `'buffer'` will return the raw body bytes as a `Uint8Array`. Any modifications will also alter the result of `.text()` and `.json()`. Before overwriting it, please copy it first via `new Uint8Array(buffer)`.\
 >  See https://github.com/nodejs/node/issues/27080
 
 ### `resolveBodyOnly`

documentation/4-pagination.md

@@ -11,7 +11,7 @@ The [RFC5988](https://datatracker.ietf.org/doc/html/rfc5988#section-5) defines h
 When the response has been processed, Got looks for [the reference of the `next` relation](https://datatracker.ietf.org/doc/html/rfc5988#section-6.2.2).\
 This way Got knows the URL it should visit afterwards. The header can look like this:
 
-```
+```text
 Link: <https://api.github.com/repositories/18193978/commits?page=2>; rel="next", <https://api.github.com/repositories/18193978/commits?page=44>; rel="last"
 ```
 

documentation/async-stack-traces.md

@@ -45,7 +45,7 @@ await new Promise((resolve, reject) => {
 });
 ```
 
-```
+```text
 node:internal/process/esm_loader:74
     internalBinding('errors').triggerUncaughtException(
                               ^
@@ -85,7 +85,7 @@ try {
 }
 ```
 
-```
+```text
 TimeoutError: Timeout awaiting 'request' for 1ms
     at ClientRequest.<anonymous> (file:///home/szm/Desktop/got/dist/source/core/index.js:780:61)
     at Object.onceWrapper (node:events:514:26)
@@ -148,7 +148,7 @@ globalThis.Error = class extends Error {
 
 If we replace the `bluebird` part with this, we get:
 
-```
+```text
 Error: Timeout awaiting 'request' for 1ms
     at ClientRequest.<anonymous> (file:///home/szm/Desktop/got/dist/source/core/index.js:780:61)
     at Object.onceWrapper (node:events:514:26)
@@ -257,7 +257,7 @@ try {
 }
 ```
 
-```
+```text
 RequestError: Timeout awaiting 'request' for 100ms
     at ClientRequest.<anonymous> (file:///home/szm/Desktop/got/dist/source/core/index.js:780:61)
     at Object.onceWrapper (node:events:514:26)

documentation/cache.md

@@ -22,8 +22,8 @@ console.log(response.isFromCache);
 
 Got uses [Keyv](https://github.com/lukechilds/keyv) internally to support a wide range of storage adapters. For something more scalable you could use an [official Keyv storage adapter](https://github.com/lukechilds/keyv#official-storage-adapters):
 
-```
-$ npm install @keyv/redis
+```sh
+npm install @keyv/redis
 ```
 
 ```js

readme.md

@@ -254,13 +254,11 @@ By default, Got will retry on failure. To disable this option, set [`options.ret
 [s3]: https://www.npmjs.com/package/superagent
 
 <!-- COVERAGE -->
-[gc]: https://img.shields.io/coveralls/github/sindresorhus/got?color=0b9062&label
 [kc]: https://img.shields.io/codecov/c/github/sindresorhus/ky?color=0b9062&label
 [nc]: https://img.shields.io/coveralls/github/bitinn/node-fetch?color=0b9062&label
 [ac]: https://img.shields.io/coveralls/github/mzabriskie/axios?color=0b9062&label
 [sc]: https://img.shields.io/codecov/c/github/visionmedia/superagent?color=0b9062&label
 
-[g4]: https://coveralls.io/github/sindresorhus/got
 [k4]: https://codecov.io/gh/sindresorhus/ky
 [n4]: https://coveralls.io/github/bitinn/node-fetch
 [a4]: https://coveralls.io/github/mzabriskie/axios
@@ -342,7 +340,6 @@ By default, Got will retry on failure. To disable this option, set [`options.ret
 [k10]: https://github.com/sindresorhus/ky
 [n10]: https://github.com/node-fetch/node-fetch
 [a10]: https://github.com/axios/axios
-[s10]: https://github.com/visionmedia/superagent
 
 <!-- LAST COMMIT -->
 [glc]: https://img.shields.io/github/last-commit/sindresorhus/got?color=gray&label

source/as-promise/index.ts

@@ -46,109 +46,111 @@ export default function asPromise<T>(firstRequest?: Request): RequestPromise<T>
 
 			globalRequest = request;
 
-			request.once('response', async (response: Response) => {
+			request.once('response', (response: Response) => {
+				void (async () => {
 				// Parse body
-				const contentEncoding = (response.headers['content-encoding'] ?? '').toLowerCase();
-				const isCompressed = compressedEncodings.has(contentEncoding);
+					const contentEncoding = (response.headers['content-encoding'] ?? '').toLowerCase();
+					const isCompressed = compressedEncodings.has(contentEncoding);
 
-				const {options} = request;
+					const {options} = request;
 
-				if (isCompressed && !options.decompress) {
-					response.body = response.rawBody;
-				} else {
-					try {
-						response.body = parseBody(response, options.responseType, options.parseJson, options.encoding);
-					} catch (error: unknown) {
-						// Fall back to `utf8`
+					if (isCompressed && !options.decompress) {
+						response.body = response.rawBody;
+					} else {
 						try {
-							response.body = decodeUint8Array(response.rawBody);
-						} catch (error) {
-							request._beforeError(new ParseError(normalizeError(error), response));
-							return;
-						}
+							response.body = parseBody(response, options.responseType, options.parseJson, options.encoding);
+						} catch (error: unknown) {
+						// Fall back to `utf8`
+							try {
+								response.body = decodeUint8Array(response.rawBody);
+							} catch (error) {
+								request._beforeError(new ParseError(normalizeError(error), response));
+								return;
+							}
 
-						if (isResponseOk(response)) {
-							request._beforeError(normalizeError(error));
-							return;
+							if (isResponseOk(response)) {
+								request._beforeError(normalizeError(error));
+								return;
+							}
 						}
 					}
-				}
 
-				try {
-					const hooks = options.hooks.afterResponse;
-
-					for (const [index, hook] of hooks.entries()) {
-						const previousUrl = options.url ? new URL(options.url) : undefined;
-						const previousState = previousUrl ? snapshotCrossOriginState(options) : undefined;
-						const requestOptions = response.request.options;
-						const responseSnapshot = response;
-
-						// @ts-expect-error TS doesn't notice that RequestPromise is a Promise
-						// eslint-disable-next-line no-await-in-loop
-						response = await requestOptions.trackStateMutations(async changedState => hook(responseSnapshot, async (updatedOptions): RequestPromise<Response> => {
-							const preserveHooks = updatedOptions.preserveHooks ?? false;
-							const reusesRequestOptions = updatedOptions === requestOptions;
-							const hasExplicitBody = reusesRequestOptions
-								? changedState.has('body') || changedState.has('json') || changedState.has('form')
-								: (Object.hasOwn(updatedOptions, 'body') && updatedOptions.body !== undefined)
-									|| (Object.hasOwn(updatedOptions, 'json') && updatedOptions.json !== undefined)
-									|| (Object.hasOwn(updatedOptions, 'form') && updatedOptions.form !== undefined);
-
-							if (hasExplicitBody && !reusesRequestOptions) {
-								options.clearBody();
-							}
+					try {
+						const hooks = options.hooks.afterResponse;
+
+						for (const [index, hook] of hooks.entries()) {
+							const previousUrl = options.url ? new URL(options.url) : undefined;
+							const previousState = previousUrl ? snapshotCrossOriginState(options) : undefined;
+							const requestOptions = response.request.options;
+							const responseSnapshot = response;
+
+							// @ts-expect-error TS doesn't notice that RequestPromise is a Promise
+							// eslint-disable-next-line no-await-in-loop
+							response = await requestOptions.trackStateMutations(async changedState => hook(responseSnapshot, async (updatedOptions): RequestPromise<Response> => {
+								const preserveHooks = updatedOptions.preserveHooks ?? false;
+								const reusesRequestOptions = updatedOptions === requestOptions;
+								const hasExplicitBody = reusesRequestOptions
+									? changedState.has('body') || changedState.has('json') || changedState.has('form')
+									: (Object.hasOwn(updatedOptions, 'body') && updatedOptions.body !== undefined)
+										|| (Object.hasOwn(updatedOptions, 'json') && updatedOptions.json !== undefined)
+										|| (Object.hasOwn(updatedOptions, 'form') && updatedOptions.form !== undefined);
+
+								if (hasExplicitBody && !reusesRequestOptions) {
+									options.clearBody();
+								}
 
-							if (!reusesRequestOptions) {
-								options.merge(updatedOptions);
-							}
+								if (!reusesRequestOptions) {
+									options.merge(updatedOptions);
+								}
 
-							if (updatedOptions.url) {
-								const nextUrl = reusesRequestOptions
-									? options.url as URL
-									: applyUrlOverride(options, updatedOptions.url, updatedOptions);
+								if (updatedOptions.url) {
+									const nextUrl = reusesRequestOptions
+										? options.url as URL
+										: applyUrlOverride(options, updatedOptions.url, updatedOptions);
 
-								if (previousUrl) {
-									if (reusesRequestOptions && !isSameOrigin(previousUrl, nextUrl)) {
-										options.stripUnchangedCrossOriginState(previousState!, changedState, {clearBody: !hasExplicitBody});
-									} else {
-										options.stripSensitiveHeaders(previousUrl, nextUrl, updatedOptions);
+									if (previousUrl) {
+										if (reusesRequestOptions && !isSameOrigin(previousUrl, nextUrl)) {
+											options.stripUnchangedCrossOriginState(previousState!, changedState, {clearBody: !hasExplicitBody});
+										} else {
+											options.stripSensitiveHeaders(previousUrl, nextUrl, updatedOptions);
 
-										if (!isSameOrigin(previousUrl, nextUrl) && !hasExplicitBody) {
-											options.clearBody();
+											if (!isSameOrigin(previousUrl, nextUrl) && !hasExplicitBody) {
+												options.clearBody();
+											}
 										}
 									}
 								}
-							}
 
-							// Remove any further hooks for that request, because we'll call them anyway.
-							// The loop continues. We don't want duplicates (asPromise recursion).
-							// Unless preserveHooks is true, in which case we keep the remaining hooks.
-							if (!preserveHooks) {
-								options.hooks.afterResponse = options.hooks.afterResponse.slice(0, index);
-							}
+								// Remove any further hooks for that request, because we'll call them anyway.
+								// The loop continues. We don't want duplicates (asPromise recursion).
+								// Unless preserveHooks is true, in which case we keep the remaining hooks.
+								if (!preserveHooks) {
+									options.hooks.afterResponse = options.hooks.afterResponse.slice(0, index);
+								}
 
-							throw new RetryError(request);
-						}));
+								throw new RetryError(request);
+							}));
 
-						if (!(is.object(response) && is.number(response.statusCode) && 'body' in response)) {
-							throw new TypeError('The `afterResponse` hook returned an invalid value');
+							if (!(is.object(response) && is.number(response.statusCode) && 'body' in response)) {
+								throw new TypeError('The `afterResponse` hook returned an invalid value');
+							}
 						}
+					} catch (error: unknown) {
+						request._beforeError(normalizeError(error));
+						return;
 					}
-				} catch (error: unknown) {
-					request._beforeError(normalizeError(error));
-					return;
-				}
 
-				globalResponse = response;
+					globalResponse = response;
 
-				if (!isResponseOk(response)) {
-					request._beforeError(new HTTPError(response));
-					return;
-				}
+					if (!isResponseOk(response)) {
+						request._beforeError(new HTTPError(response));
+						return;
+					}
 
-				request.destroy();
-				promiseSettled = true;
-				resolve(request.options.resolveBodyOnly ? response.body as T : response as unknown as T);
+					request.destroy();
+					promiseSettled = true;
+					resolve(request.options.resolveBodyOnly ? response.body as T : response as unknown as T);
+				})();
 			});
 
 			let handledFinalError = false;
@@ -250,7 +252,7 @@ export default function asPromise<T>(firstRequest?: Request): RequestPromise<T>
 
 			if (responseType === 'text') {
 				const text = decodeUint8Array(globalResponse.rawBody, options.encoding);
-				return (isUtf8Encoding(options.encoding) ? text.replace(/^\uFEFF/u, '') : text) as T;
+				return (isUtf8Encoding(options.encoding) ? text.replace(/^\u{FEFF}/v, '') : text) as T;
 			}
 
 			return parseBody(globalResponse, responseType, options.parseJson, options.encoding);