Fix typos

Author: sindresorhus

readme.md

@@ -28,7 +28,7 @@ It's just a tiny package with no dependencies.
 - Base URL option
 - Instances with custom defaults
 - Hooks
-- TypeScript niceties (e.g. `.json()` supports generics and defaults to `unknown`, not `any`)
+- TypeScript niceties (e.g., `.json()` supports generics and defaults to `unknown`, not `any`)
 
 ## Install
 
@@ -197,7 +197,7 @@ When passing an object, setting a value to `undefined` deletes the parameter, wh
 
 Type: `string | URL`
 
-A base URL to [resolve](https://developer.mozilla.org/en-US/docs/Web/API/URL_API/Resolving_relative_references) the `input` against. When the `input` (after applying the `prefix` option) is only a relative URL, such as `'users'`, `'/users'`,  or `'//my-site.com'`, it will be resolved against the `baseUrl` to determine the destination of the request. Otherwise, the `input` is absolute, such as `'https://my-site.com'`, and it will bypass the `baseUrl`.
+A base URL to [resolve](https://developer.mozilla.org/en-US/docs/Web/API/URL_API/Resolving_relative_references) the `input` against. When the `input` (after applying the `prefix` option) is only a relative URL, such as `'users'`, `'/users'`, or `'//my-site.com'`, it will be resolved against the `baseUrl` to determine the destination of the request. Otherwise, the `input` is absolute, such as `'https://my-site.com'`, and it will bypass the `baseUrl`.
 
 Useful when used with [`ky.extend()`](#kyextenddefaultoptions) to create niche-specific Ky-instances.
 
@@ -576,7 +576,7 @@ const response = await ky('https://example.com/api', {
 Type: `Function[]`\
 Default: `[]`
 
-This hook enables you to modify any error right before it is thrown. The hook function receives a state object with the current request, the normalized Ky options, error, and retry count, and should return an `Error` instance.
+This hook enables you to modify any error right before it is thrown. The hook function receives a state object with the current request, the normalized Ky options, the error, and retry count, and should return an `Error` instance.
 
 This hook is called for all error types, including `HTTPError`, `NetworkError`, `TimeoutError`, and `ForceRetryError` (when retry limit is exceeded via `ky.retry()`). Use type guards like `isHTTPError()`, `isNetworkError()`, or `isTimeoutError()` to handle specific error types.
 
@@ -1207,7 +1207,7 @@ It also has a `data` property with the pre-parsed response body. For JSON respon
 Be aware that some types of errors, such as network errors, inherently mean that a response was not received. In that case, the error will be an instance of [`NetworkError`](#networkerror) instead of `HTTPError` and will not contain a `response` property.
 
 > [!NOTE]
-> The response body is automatically consumed when populating `error.data`, so you do not need to manually consume or cancel `error.response.body`.
+> The response body is automatically consumed when populating `error.data`, so `error.response.json()` and other body methods will not work. Use `error.data` instead. The `error.response` object is still available for headers, status, etc.
 
 ```js
 import ky, {isHTTPError} from 'ky';

source/core/Ky.ts

@@ -150,7 +150,7 @@ export class Ky {
 					continue;
 				}
 
-				// Opaque responses (`response.type === 'opaque'`) from `no-cors` requests always have `status: 0` and `ok: false`, but this is not a failure — the actual status is hidden by the browser.
+				// Opaque responses (`response.type === 'opaque'`) from `no-cors` requests always have `status: 0` and `ok: false`, but this is not a failure - the actual status is hidden by the browser.
 				if (!response.ok && response.type !== 'opaque' && (
 					typeof ky.#options.throwHttpErrors === 'function'
 						? ky.#options.throwHttpErrors(response.status)
@@ -205,7 +205,7 @@ export class Ky {
 			try {
 				return await function_();
 			} catch (error: unknown) {
-				// Non-Error throws (e.g. thrown strings) pass through unchanged
+				// Non-Error throws (e.g., thrown strings) pass through unchanged
 				if (!(error instanceof Error)) {
 					throw error;
 				}
@@ -875,7 +875,7 @@ export class Ky {
 		const request = this.#wrapRequestWithUploadProgress(this.request, this.#options.body ?? undefined);
 
 		// Cloning is done here to prepare in advance for retries.
-		// Skip cloning when retries are disabled — cloning a streaming body calls ReadableStream#tee()
+		// Skip cloning when retries are disabled - cloning a streaming body calls ReadableStream#tee()
 		// which buffers the entire stream in memory, causing excessive memory usage for large uploads.
 		this.#originalRequest = request;
 		if (retryRequest) {

source/core/constants.ts

@@ -57,7 +57,7 @@ export const responseTypes = {
 // The maximum value of a 32bit int (see issue #117)
 export const maxSafeTimeout = 2_147_483_647;
 
-// Size in bytes of a typical form boundary (e.g. '------WebKitFormBoundaryaxpyiPgbbPti10Rw'), used to help estimate upload size
+// Size in bytes of a typical form boundary (e.g., '------WebKitFormBoundaryaxpyiPgbbPti10Rw'), used to help estimate upload size
 export const usualFormBoundarySize = 40;
 
 /**
@@ -104,7 +104,7 @@ export type ForceRetryOptions = {
 	} catch (error) {
 		return ky.retry({
 			code: 'VALIDATION_FAILED',
-			cause: error  // Preserves original error in chain
+			cause: error // Preserves original error in chain
 		});
 	}
 	```

source/errors/HTTPError.ts

@@ -6,7 +6,7 @@ import {KyError} from './KyError.js';
 /**
 Error thrown when the response has a non-2xx status code and `throwHttpErrors` is enabled.
 
-The error has a `response` property with the `Response` object, a `request` property with the `Request` object, an `options` property with the normalized options, and a `data` property with the pre-parsed response body.
+The error has a `response` property with the `Response` object, a `request` property with the `Request` object, an `options` property with the normalized options, and a `data` property with the pre-parsed response body. The response body is automatically consumed when populating `data`, so `response.json()` and other body methods will not work. Use `data` instead.
 */
 export class HTTPError<T = unknown> extends KyError {
 	override name = 'HTTPError' as const;

source/types/ResponsePromise.ts

@@ -1,5 +1,5 @@
 /**
-Returns a `Response` object with `Body` methods added for convenience. So you can, for example, call `ky.get(input).json()` directly without having to await the `Response` first. When called like that, an appropriate `Accept` header will be set depending on the body method used. Unlike the `Body` methods of `window.Fetch`; these will throw an `HTTPError` if the response status is not in the range of `200...299`. Also, `.json()` will return `undefined` if body is empty or the response status is `204` instead of throwing a parse error due to an empty body.
+Returns a `Response` object with `Body` methods added for convenience. So you can, for example, call `ky.get(input).json()` directly without having to await the `Response` first. When called like that, an appropriate `Accept` header will be set depending on the body method used. Unlike the `Body` methods of `window.fetch`, these will throw an `HTTPError` if the response status is not in the range of `200...299`. Also, `.json()` will return `undefined` if body is empty or the response status is `204` instead of throwing a parse error due to an empty body.
 */
 import {type KyResponse} from './response.js';
 import type {StandardSchemaV1, StandardSchemaV1InferOutput} from './standard-schema.js';

source/types/options.ts

@@ -111,7 +111,7 @@ export type KyOptions = {
 	searchParams?: SearchParamsOption;
 
 	/**
-	A base URL to [resolve](https://developer.mozilla.org/en-US/docs/Web/API/URL_API/Resolving_relative_references) the `input` against. When the `input` (after applying the `prefix` option) is only a relative URL, such as `'users'`, `'/users'`,  or `'//my-site.com'`, it will be resolved against the `baseUrl` to determine the destination of the request. Otherwise, the `input` is absolute, such as `'https://my-site.com'`, and it will bypass the `baseUrl`.
+	A base URL to [resolve](https://developer.mozilla.org/en-US/docs/Web/API/URL_API/Resolving_relative_references) the `input` against. When the `input` (after applying the `prefix` option) is only a relative URL, such as `'users'`, `'/users'`, or `'//my-site.com'`, it will be resolved against the `baseUrl` to determine the destination of the request. Otherwise, the `input` is absolute, such as `'https://my-site.com'`, and it will bypass the `baseUrl`.
 
 	Useful when used with [`ky.extend()`](#kyextenddefaultoptions) to create niche-specific Ky-instances.
 
@@ -142,8 +142,8 @@ export type KyOptions = {
 	*In most cases, you should use the `baseUrl` option instead, as it is more consistent with web standards. However, `prefix` is useful if you want origin-relative `input` URLs, such as `/users`, to be treated as if they were page-relative. In other words, the leading slash of the `input` will essentially be ignored, because the `prefix` will become part of the `input` before URL resolution happens.*
 
 	Notes:
- 	 - The `prefix` and `input` are joined with a slash `/`, and slashes are normalized at the join boundary by trimming trailing slashes from `prefix` and leading slashes from `input`.
-	 - After `prefix` and `input` are joined, the result is resolved against the `baseUrl` option, if present.
+	- The `prefix` and `input` are joined with a slash `/`, and slashes are normalized at the join boundary by trimming trailing slashes from `prefix` and leading slashes from `input`.
+	- After `prefix` and `input` are joined, the result is resolved against the `baseUrl` option, if present.
 
 	@example
 	```

source/utils/type-guards.ts

@@ -4,7 +4,7 @@ import {NetworkError} from '../errors/NetworkError.js';
 import {TimeoutError} from '../errors/TimeoutError.js';
 import {ForceRetryError} from '../errors/ForceRetryError.js';
 
-// Handles cross-realm cases (e.g. iframes, different JS contexts) where `instanceof` fails.
+// Handles cross-realm cases (e.g., iframes, different JS contexts) where `instanceof` fails.
 const isErrorType = (error: unknown, cls: {name: string}): boolean =>
 	error instanceof (cls as any) || (error as any)?.name === cls.name;