fix(RequestInit): restrict body type based on method to improve type safety #1953
Conversation
This file contains 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
|
Thanks for the PR! This section of the codebase is owned by @saschanaz - if they write a comment saying "LGTM" then it will be merged. |
saschanaz
reviewed
Mar 30, 2025
| @@ -1953,7 +1953,7 @@ interface ReportingObserverOptions { | |||
|
|
|||
| interface RequestInit { | |||
| /** A BodyInit object or null to set request's body. */ | |||
| body?: BodyInit | null; | |||
| body?: 'GET' | 'HEAD' extends this['method'] ? never : BodyInit | null | null; | |||
There was a problem hiding this comment.
This won't work if method is a general string, e.g.:
function download(url: URL, method: string, body: any) {
return fetch(url, { method, body });
}Or method is lowercased or something weird like "gET" (this still works in browsers as the browser internally makes it uppercase). Actually not sure this would work even if method is GET/HEAD, can you add a unit test?
There was a problem hiding this comment.
Actually, when I think about it more, it seems that this is a missing feature in TypeScript. TS needs to have a Template Literal Type for case-insensitive matching.
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.
fixes #1678