-
-
Notifications
You must be signed in to change notification settings - Fork 6.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add mock return matchers #5879
Merged
Merged
Add mock return matchers #5879
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
7a3cf01
Add toReturnValues and toHaveReturnedValues
rickhanlonii e25cc3c
Fix typos
rickhanlonii 9c7ec28
Add spy matchers to pair with called
rickhanlonii 19aada6
Clean up matchers
rickhanlonii c8d094b
Update docs
rickhanlonii 64640a6
rm dupe note
rickhanlonii 22b6884
Updates based on feedback
rickhanlonii 3603150
Remove quotes
rickhanlonii c722a08
Update changelog
rickhanlonii d3d1b5a
Merge branch 'master' into rh-return-matchers
rickhanlonii 19bbe7c
Revert this
rickhanlonii e8a669a
Lint md
rickhanlonii File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -649,6 +649,22 @@ test('drinkEach drinks each drink', () => { | |
}); | ||
``` | ||
|
||
### `.toHaveReturned(value)` | ||
|
||
Also under the alias: `.toReturn(value)` | ||
|
||
If you have a mock function, you can use `.toHaveReturned` to test that the spy | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we call it "spy"? |
||
returned a value. For example, let's say you have a mock `drink` that returns | ||
`true`. You can write: | ||
|
||
```js | ||
test('drinks returns true', () => { | ||
const drink = jest.fn(() => true); | ||
drink(); | ||
expect(drink).toHaveReturned(true); | ||
}); | ||
``` | ||
|
||
### `.toBeCloseTo(number, numDigits)` | ||
|
||
Using exact equality with floating point numbers is a bad idea. Rounding means | ||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should doc every new matcher, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, ignore me then :D