fix: support typing overloaded functions #1
Merged
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.
Overview
TypeScript's built in
Parameters
andReturnType
utilities do not understand overloaded functions. This makes stubbing overloaded functions quite difficult withvitest-when
, becausecalledWith
,thenReturn
, et. al. will get typed to accept the last overload rather than a union of all overloads.This PR adds improves the typing for overloaded functions in two ways:
calledWith
will accept a union of all overloaded argumentsthenReturn
/thenResolve
will accept the specific return type given the arguments used incalledWith
Change log
vi.fn()
, untyped functions, non-overloaded functions, and overloaded functions