feat: add return types for request.parseSuccessResponseBody

src/RequestInterface.ts

@@ -3,8 +3,15 @@ import type { OctokitResponse } from "./OctokitResponse";
 import type { RequestParameters } from "./RequestParameters";
 import type { Route } from "./Route";
 
-import type { Endpoints } from "./generated/Endpoints";
+import type { Endpoints, Simplify } from "./generated/Endpoints";
 
+/**
+ * Parameters that can be passed into `request(route, parameters)` or `endpoint(route, parameters)` methods.
+ * This type represents the options when `request.parseSuccessResponseBody` is set to `false`.
+ */
+type StreamBodyOption = Simplify<
+  RequestParameters & { request: { parseSuccessResponseBody: false } }
+>;
 export interface RequestInterface<D extends object = object> {
   /**
    * Sends a request based on endpoint options
@@ -17,6 +24,38 @@ export interface RequestInterface<D extends object = object> {
         : { url: string }),
   ): Promise<OctokitResponse<T>>;
 
+  /**
+   * Sends a request based on endpoint options
+   *
+   * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
+   */
+  <T = any, O extends StreamBodyOption = StreamBodyOption>(
+    options: O & { method?: string } & ("url" extends keyof D
+        ? { url?: string }
+        : { url: string }),
+  ): Promise<OctokitResponse<ReadableStream<T>>>;
+
+  /**
+   * Sends a request based on endpoint options
+   *
+   * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
+   * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`.
+   */
+  <R extends Route, O extends StreamBodyOption>(
+    route: keyof Endpoints | R,
+    options?: R extends keyof Endpoints
+      ? Endpoints[R]["parameters"] & O
+      : StreamBodyOption,
+  ): R extends keyof Endpoints
+    ? Promise<
+        OctokitResponse<
+          ReadableStream<
+            Exclude<Endpoints[R]["response"], keyof OctokitResponse<any>>
+          >
+        >
+      >
+    : Promise<OctokitResponse<ReadableStream<any>>>;
+
   /**
    * Sends a request based on endpoint options
    *

test.ts

@@ -54,10 +54,7 @@
 const listForRef = {} as {
   (
     params?: RequestParameters &
-      Omit<
         Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"]["parameters"],
-        "baseUrl" | "headers" | "mediaType"
-      >
   ): Promise<Endpoints[typeof checkRunsRoute]["response"]>;
   defaults: RequestInterface["defaults"];
   endpoint: EndpointInterface<{
@@ -66,4 +63,4 @@
 };
 
 // octokit.paginate can take `request` method. ref: https://github.com/octokit/plugin-paginate-rest.js/blob/b3fb11e301f9658554e110aeebbd7cbb89b8aad4/README.md?plain=1#L117-L126
 assertPaginate(listForRef);