doc: update toHaveBeenCalledWith to include type of equality check #11026
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.
Summary
The documentation for
.toHaveBeenCalledWith
doesn't state the type of equality check performed on the argument.This means that anyone expecting the object argument used in the mock function
.toStrictEqual
the passed argument will be confused as the call is actually.toEqual
and doesn't compare object classes.See https://github.com/byrne-greg/jest-toHaveBeenCalledWith-equal-example/blob/main/index.test.js as an example
Test plan