fix(types): add explicit | undefined to optional fields (#462)

When typescript is used with the option `exactOptionalProperty: true`, this code fails to typecheck if `undefined` is passed in for the response value. This is because `exactOptionalProperty` makes tsc consider `?:..` different from `: ... | undefined` for more strictness.
octokit · Sep 24, 2024 · 43fc3bd · 43fc3bd
1 parent cd5dc6e
commit 43fc3bd
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -20,7 +20,7 @@ export class RequestError extends Error {
   /**
    * Response object if a response was received
    */
-  response?: OctokitResponse<unknown>;
+  response?: OctokitResponse<unknown> | undefined;
 
   constructor(
     message: string,

diff --git a/src/types.ts b/src/types.ts
@@ -1,6 +1,6 @@
 import type { RequestOptions, OctokitResponse } from "@octokit/types";
 
 export type RequestErrorOptions = {
-  response?: OctokitResponse<unknown>;
+  response?: OctokitResponse<unknown> | undefined;
   request: RequestOptions;
 };