Alias spy.reset to spy.resetHistory #1630
Merged
Conversation
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
fatso83
requested changes
Dec 8, 2017
docs/release-source/release/spies.md
Outdated
|
|
||
| Resets the state of a spy. | ||
|
|
||
|
|
||
| #### `spy.reset()` |
There was a problem hiding this comment.
Remove this. If it's deprecated we don't need to spread knowledge of its existence. Only old code-bases should use this.
lib/sinon/spy.js
Outdated
| @@ -413,6 +413,8 @@ function delegateToCalls(method, matchAny, actual, notCalled) { | |||
| }; | |||
| } | |||
|
|
|||
| spyApi.reset = spyApi.resetHistory; | |||
There was a problem hiding this comment.
This needs to be be wrapped in our deprecation helper. See lib/sinon/util/core/deprecated.js
|
Thanks for the feedback @fatso83 I'll take a look after the weekend. |
2 tasks
|
Okay @fatso83 this is ready for re-review - do you think we need a test for the deprecated |
fatso83
approved these changes
Dec 11, 2017
|
This was fine, no worries. Thanks a lot! |
|
This has been released with |
This was referenced May 8, 2018
maxholman
added a commit
to maxholman/debug3
that referenced
this pull request
Jan 7, 2019
maxholman
added a commit
to maxholman/debug3
that referenced
this pull request
Jan 7, 2019
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.
Purpose (TL;DR) - mandatory
As per #1446 - deprecates and aliases
spy.resetin favour ofspy.resetHistoryBackground (Problem in detail) - optional
See ticket.
Solution - optional
spy.resettest to instead usespy.resetHistoryspy.resettest to make sure alias worksHow to verify - mandatory
npm installnpm testChecklist for author
npm run lintpasses