fix(types): Fix clone method type declaration to be an instance method rather than instance property#4925
Open
mistval wants to merge 1 commit intonodejs:mainfrom
Open
fix(types): Fix clone method type declaration to be an instance method rather than instance property#4925mistval wants to merge 1 commit intonodejs:mainfrom
mistval wants to merge 1 commit intonodejs:mainfrom
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 relates to...
The
Responsetype declaration currently declarescloneas an instance property, but it's actually an instance method. This PR updates the type declaration to reflect that, and also makes the equivalent change to theRequesttype declaration which is in the same situation.Rationale
The distinction between a function instance property and an instance method rarely matters, but can impact certain use cases, including trying to extend Response and override the method. For example this code emits TS errors yet works fine:
TS errors:
This change also aligns with the built in TS lib DOM which declares the method like so:
This rationale applies equally to
Request.prototype.clonetoo.Changes
Response.clone()fromreadonly clone: () => Responsetopublic clone (): Response.Request.clone()fromreadonly clone: () => Requesttopublic clone (): Request.Features
N/A
Bug Fixes
N/A
Breaking Changes and Deprecations
N/A
I can't think of a situation where this would break anything, as both before and after,
typeof Response.prototype.cloneis() => Response.Status