From f3c395cfdc2066d93a178a751d0c34d388dafe4d Mon Sep 17 00:00:00 2001 From: Lindsey Stead Date: Fri, 28 Nov 2025 10:31:47 -0800 Subject: [PATCH 1/2] fix: correct onError middleware syntax in docs Fixes #2517 Removed nested onError function that caused TypeScript error. The correct syntax is to directly return an Error instance from the onError method, not nest another onError function inside it. --- docs/openapi-fetch/api.md | 4 +--- docs/openapi-fetch/middleware-auth.md | 4 +--- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/openapi-fetch/api.md b/docs/openapi-fetch/api.md index 8a9202f11..28e316caf 100644 --- a/docs/openapi-fetch/api.md +++ b/docs/openapi-fetch/api.md @@ -242,9 +242,7 @@ const myMiddleware: Middleware = { }, async onError({ error }) { // wrap errors thrown by fetch - onError({ error }) { - return new Error("Oops, fetch failed", { cause: error }); - }, + return new Error("Oops, fetch failed", { cause: error }); }, }; diff --git a/docs/openapi-fetch/middleware-auth.md b/docs/openapi-fetch/middleware-auth.md index 7a0e53967..d016139e1 100644 --- a/docs/openapi-fetch/middleware-auth.md +++ b/docs/openapi-fetch/middleware-auth.md @@ -29,9 +29,7 @@ const myMiddleware: Middleware = { }, async onError({ error }) { // wrap errors thrown by fetch - onError({ error }) { - return new Error("Oops, fetch failed", { cause: error }); - }, + return new Error("Oops, fetch failed", { cause: error }); }, }; From 35abf54c08f420d2073d4f96a7438453731210be Mon Sep 17 00:00:00 2001 From: Lindsey Stead Date: Tue, 2 Dec 2025 00:56:56 -0800 Subject: [PATCH 2/2] chore: add changeset for middleware onError docs fix --- .changeset/fix-middleware-onerror-docs.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .changeset/fix-middleware-onerror-docs.md diff --git a/.changeset/fix-middleware-onerror-docs.md b/.changeset/fix-middleware-onerror-docs.md new file mode 100644 index 000000000..0c1804ab4 --- /dev/null +++ b/.changeset/fix-middleware-onerror-docs.md @@ -0,0 +1,7 @@ +--- +"openapi-fetch": patch +--- + +Fix incorrect `onError` middleware docs example that caused a TypeScript error when copy-pasted. + +