docs: add comment about optional parameter (#556)

octokit · Jun 11, 2023 · e194847 · e194847
1 parent d7ad4ba
commit e194847
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/scripts/update-endpoints/templates/endpoints.ts.template b/scripts/update-endpoints/templates/endpoints.ts.template
@@ -14,6 +14,8 @@ type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
 type ExtractParameters<T> = "parameters" extends keyof T
   ? UnionToIntersection<
       {
+        // query paramter might be optional
+        // https://github.com/octokit/types.ts/pull/555#issuecomment-1585105522
         [K in keyof T["parameters"]]-?: T["parameters"][K];
       }[keyof T["parameters"]]
     >

diff --git a/src/generated/Endpoints.ts b/src/generated/Endpoints.ts
@@ -14,6 +14,8 @@ type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
 type ExtractParameters<T> = "parameters" extends keyof T
   ? UnionToIntersection<
       {
+        // query paramter might be optional
+        // https://github.com/octokit/types.ts/pull/555#issuecomment-1585105522
         [K in keyof T["parameters"]]-?: T["parameters"][K];
       }[keyof T["parameters"]]
     >