feat: improve fetchOptions type definition - #10961
Open
anhlecongtran wants to merge 1 commit into
Open
Conversation
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
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.
This PR addresses issue #6869.
The current fetchOptions type definition includes Record<string, any>, which reduces TypeScript type safety and IDE autocomplete support. This change updates the type definition to rely on RequestInit, which aligns with the Fetch API standard and improves developer experience.
Changes:
Related Issue:
#6869
Summary by cubic
Tighten
fetchOptionstyping to only allowRequestInitfields, removingRecord<string, any>. This improves type safety and IDE autocomplete, and may surface invalid option usage at compile time.Description
Record<string, any>fromfetchOptions.fetchOptionsasOmit<RequestInit, 'body' | 'headers' | 'method' | 'signal'>.Docs
Update
/docs/to state thatfetchOptionsaccepts onlyRequestInitfields (excludingbody,headers,method,signal). Remove any mention of arbitrary custom keys.Testing
RequestInitkeys are accepted and invalid keys fail type-check.Semantic version impact
Breaking (types-only): narrows the public type and can cause new TypeScript errors for consumers passing non-
RequestInitfields.Written for commit 0573372. Summary will update on new commits.