docs: add comment about optional parameter (#556)

gr2m · web-flow · commit e194847b83ce · 2023-06-11T14:52:04.000-04:00
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"]]
     >

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@ type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (`
`14`	`14`	`type ExtractParameters<T> = "parameters" extends keyof T`
`15`	`15`	`? UnionToIntersection<`
`16`	`16`	`{`
	`17`	`+ // query paramter might be optional`
	`18`	`+ // https://github.com/octokit/types.ts/pull/555#issuecomment-1585105522`
`17`	`19`	`[K in keyof T["parameters"]]-?: T["parameters"][K];`
`18`	`20`	`}[keyof T["parameters"]]`
`19`	`21`	`>`