Add custom fetch option (openapi-ts#1119)

Author: drwpow

CHANGELOG.md

@@ -1,5 +1,11 @@
 # openapi-fetch
 
+## 0.2.0
+
+### Minor Changes
+
+- 97c8757: Add custom fetch option (#51). Thanks, [@hd-o](https://github.com/hd-o)!
+
 ## 0.1.4
 
 ### Patch Changes

README.md

@@ -144,6 +144,7 @@ createClient<paths>(options);
 | Name            |   Type   | Description                                                                                                                                                                                   |
 | :-------------- | :------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `baseUrl`       | `string` | Prefix all fetch URLs with this option (e.g. `"https://myapi.dev/v1/"`).                                                                                                                      |
+| `fetch`         | `fetch`  | Fetch function used for requests (defaults to `globalThis.fetch`)                                                                                                                             |
 | (Fetch options) |          | Any valid fetch option (`headers`, `mode`, `cache`, `signal` …) (<a href="https://developer.mozilla.org/en-US/docs/Web/API/fetch#options" target="_blank" rel="noopener noreferrer">docs</a>) |
 
 ### Fetch options

package.json

@@ -52,7 +52,7 @@
     "openapi-typescript": "workspace:^",
     "prettier": "^2.8.8",
     "typescript": "^5.0.4",
-    "vitest": "^0.31.0",
+    "vitest": "^0.31.1",
     "vitest-fetch-mock": "^0.2.2"
   }
 }

src/index.test.ts

@@ -180,6 +180,20 @@ describe("client", () => {
       })
     );
   });
+
+  it("accepts a custom fetch function", async () => {
+    const data = { works: true };
+    const client = createClient<paths>({
+      fetch: async () =>
+        Promise.resolve({
+          headers: new Headers(),
+          json: async () => data,
+          status: 200,
+          ok: true,
+        } as Response),
+    });
+    expect((await client.get("/self", {})).data).toBe(data);
+  });
 });
 
 describe("get()", () => {

src/index.ts

@@ -7,6 +7,8 @@ const DEFAULT_HEADERS = {
 interface ClientOptions extends RequestInit {
   /** set the common root URL for all API requests */
   baseUrl?: string;
+  /** custom fetch (defaults to globalThis.fetch) */
+  fetch?: typeof fetch;
 }
 export interface BaseParams {
   params?: { query?: Record<string, unknown> };
@@ -51,17 +53,19 @@ export type FetchResponse<T> =
   | { data: T extends { responses: any } ? NonNullable<FilterKeys<Success<T["responses"]>, JSONLike>> : unknown; error?: never; response: Response }
   | { data?: never; error: T extends { responses: any } ? NonNullable<FilterKeys<Error<T["responses"]>, JSONLike>> : unknown; response: Response };
 
-export default function createClient<Paths extends {}>(options?: ClientOptions) {
+export default function createClient<Paths extends {}>(clientOptions: ClientOptions = {}) {
+  const { fetch = globalThis.fetch, ...options } = clientOptions;
+
   const defaultHeaders = new Headers({
     ...DEFAULT_HEADERS,
-    ...(options?.headers ?? {}),
+    ...(options.headers ?? {}),
   });
 
   async function coreFetch<P extends keyof Paths, M extends HttpMethod>(url: P, fetchOptions: FetchOptions<M extends keyof Paths[P] ? Paths[P][M] : never>): Promise<FetchResponse<M extends keyof Paths[P] ? Paths[P][M] : unknown>> {
     const { headers, body: requestBody, params = {}, querySerializer = (q: QuerySerializer<M extends keyof Paths[P] ? Paths[P][M] : never>) => new URLSearchParams(q as any).toString(), ...init } = fetchOptions || {};
 
     // URL
-    let finalURL = `${options?.baseUrl ?? ""}${url as string}`;
+    let finalURL = `${options.baseUrl ?? ""}${url as string}`;
     if ((params as any).path) {
       for (const [k, v] of Object.entries((params as any).path)) finalURL = finalURL.replace(`{${k}}`, encodeURIComponent(String(v)));
     }