fix(spy): fix mockImplementation
for function overload and unions
#6181
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.
Description
Previously we had
mockImplementation(fn: T)
whereT extends (...args: any[]) => any
, but suchT
can include arbitrary overload and union types, so it looks like it's important to have singly picked function type(...args: Paramters<T>) => ReturnType<T>
for the most reasonable usability.There are probably two ways to solve this. One way is like this PR to
NormalizedPrecedure<T>
insideMockInstance<T>
. Another way which Jest does is to have a wrapperSpiedFunction<T>
forMockInstance<(...args: Parameters<T>) => ReturnType<T>>
.I think what Jest does still have issues left (though I'm not sure if it's intentional or not). For example,
SpiedFunction
doesn't cover the case ofvi.mocked
helper, so it would fail the example from OP #6155. So, I thought it's more robust to go with the former approach.Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
pnpm-lock.yaml
unless you introduce a new test example.Tests
pnpm test:ci
.Documentation
pnpm run docs
command.Changesets
feat:
,fix:
,perf:
,docs:
, orchore:
.