docs: propose custom-response-object change - #5
Merged
Conversation
Adds proposal, design, tasks, and an http-client spec delta for
wrapping createFetchify's HTTP methods in a FetchifyResponse
{ data, response } object instead of returning the raw fetch Response.
FetchifyResponse<T = string> and FetchifyMethod<T> let callers write
client.get<User>("/user") and get a typed, JSON-parsed data property
(falling back to raw text for non-JSON bodies).
Each client method now resolves to { data, response } instead of the
raw fetch Response. data is the parsed body (JSON with a text
fallback) when the response is ok, or null otherwise; response is an
unread clone of the original Response for callers who need json()/
blob()/status/headers directly. Methods accept an optional generic
(client.get<User>("/user")) to type data.
BREAKING CHANGE: FetchifyMethod's return type changed from
Promise<Response> to Promise<FetchifyResponse<T>>.
DOCS.md was still describing createFetchify's methods as returning the raw fetch Response.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds proposal, design, tasks, and an http-client spec delta for
wrapping createFetchify's HTTP methods in a FetchifyResponse
{ data, response } object instead of returning the raw fetch Response.