Add request and options to HTTPError (#309)

Co-authored-by: Seth Holladay <me@seth-holladay.com>
Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

Author: 3 people

index.d.ts

@@ -414,11 +414,13 @@ export interface ResponsePromise extends Promise<Response> {
 }
 
 /**
-The error has a response property with the `Response` object.
+Exposed for `instanceof` checks. The error has a `response` property with the [`Response` object](https://developer.mozilla.org/en-US/docs/Web/API/Response), `request` property with the [`Request` object](https://developer.mozilla.org/en-US/docs/Web/API/Request), and `options` property with normalized options (either passed to `ky` when creating an instance with `ky.create()` or directly when performing the request).
 */
 declare class HTTPError extends Error {
-	constructor(response: Response);
+	constructor(response: Response, request: Request, options: NormalizedOptions);
 	response: Response;
+	request: Request;
+	options: NormalizedOptions;
 }
 
 /**

index.js

@@ -118,7 +118,7 @@ const retryAfterStatusCodes = [
 const stop = Symbol('stop');
 
 class HTTPError extends Error {
-	constructor(response) {
+	constructor(response, request, options) {
 		// Set the message to the status text, such as Unauthorized,
 		// with some fallbacks. This message should never be undefined.
 		super(
@@ -130,6 +130,8 @@ class HTTPError extends Error {
 		);
 		this.name = 'HTTPError';
 		this.response = response;
+		this.request = request;
+		this.options = options;
 	}
 }
 
@@ -292,7 +294,7 @@ class Ky {
 			this._decorateResponse(response);
 
 			if (!response.ok && this._options.throwHttpErrors) {
-				throw new HTTPError(response);
+				throw new HTTPError(response, this.request, this._options);
 			}
 
 			// If `onDownloadProgress` is passed, it uses the stream API internally

index.test-d.ts

@@ -23,7 +23,13 @@ for (const method of requestMethods) {
 
 expectType<typeof ky>(ky.create({}));
 expectType<typeof ky>(ky.extend({}));
-expectType<InstanceType<typeof ky.HTTPError>>(new ky.HTTPError(new Response()));
+expectType<InstanceType<typeof ky.HTTPError>>(
+	new ky.HTTPError(
+		new Response(),
+		new Request('https://example.com'),
+		{} as NormalizedOptions
+	)
+);
 expectType<InstanceType<typeof ky.TimeoutError>>(new ky.TimeoutError(new Request('Test')));
 
 ky(url, {

readme.md

@@ -450,11 +450,11 @@ Type: `object`
 
 ### ky.HTTPError
 
-Exposed for `instanceof` checks. The error has a `response` property with the [`Response` object](https://developer.mozilla.org/en-US/docs/Web/API/Response).
+Exposed for `instanceof` checks. The error has a `response` property with the [`Response` object](https://developer.mozilla.org/en-US/docs/Web/API/Response), `request` property with the [`Request` object](https://developer.mozilla.org/en-US/docs/Web/API/Request), and `options` property with normalized options (either passed to `ky` when creating an instance with `ky.create()` or directly when performing the request).
 
 ### ky.TimeoutError
 
-The error thrown when the request times out.
+The error thrown when the request times out. It has a `request` property with the [`Request` object](https://developer.mozilla.org/en-US/docs/Web/API/Request).
 
 ### ky.stop