Skip to content

feat: Attach fetch response to SWR data/error#2246

Closed
Tommos0 wants to merge 2 commits intoopenapi-ts:mainfrom
Tommos0:patch-1
Closed

feat: Attach fetch response to SWR data/error#2246
Tommos0 wants to merge 2 commits intoopenapi-ts:mainfrom
Tommos0:patch-1

Conversation

@Tommos0
Copy link
Copy Markdown

@Tommos0 Tommos0 commented Apr 8, 2025

Changes

It is useful to have the original fetch response available in the hook result. For instance to distinguish the HTTP status code in case of an error. Since SWR only returns error / data properties, this provides an escape hatch to be able to access to original fetch response, as returned by the openapi-fetch client.

This will probably fail for JSON bodies that parse to primitives (null/string).

#2238

Checklist

I was unable to run the test suite, making it hard to add / update unit tests for me.

It is useful to have the original fetch response available in the hook result. For instance to distinguish the HTTP status code in case of an `error`.
Since SWR only returns `error` / `data` properties, this provides an escape hatch to be able to access to original `fetch` response, as returned by the `openapi-fetch` client.
@Tommos0 Tommos0 requested a review from a team as a code owner April 8, 2025 08:26
@Tommos0 Tommos0 requested a review from duncanbeevers April 8, 2025 08:26
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 8, 2025

👷 Deploy request for openapi-ts accepted.

Name Link
🔨 Latest commit deef3fe
🔍 Latest deploy log https://app.netlify.com/projects/openapi-ts/deploys/67f4ddd2015f990007f9c55c

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 8, 2025

⚠️ No Changeset found

Latest commit: 4070c42

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Copy Markdown
Contributor

@drwpow drwpow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Not opposed to this fix itself, but we will need a test to make sure this doesn’t regress in the future.

Could you describe the error you were seeing when running the test suite? Are you on the current LTS Node version (22) and did you follow the instructions in CONTRIBUTING.md?

@gzm0 gzm0 added the swr-openapi Relevant to swr-openapi library label Oct 2, 2025
@drwpow
Copy link
Copy Markdown
Contributor

drwpow commented Feb 8, 2026

Just a heads up: the repo has since been moved here, so this PR will need to be moved to changeset-release/main. Please feel free to repoen there! (But the test requirements will be the same)

@drwpow drwpow closed this Feb 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

swr-openapi Relevant to swr-openapi library

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants