docs(cy.stub): Update syntax to use callsFake() instead of deprecated third argument #5955
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
… third argument Update cy.stub() documentation to reflect the latest Sinon.JS syntax: - Remove deprecated `cy.stub(object, method, replacerFn)` syntax - Add `cy.stub(object, method).callsFake(replacerFn)` as the recommended approach - Update related examples to use the new syntax This change aligns the Cypress documentation with Sinon.JS v3.0.0+ practices, replacing the deprecated three-argument stub syntax with the `callsFake()` method.
👷 Deploy request for cypress-docs pending review.Visit the deploys page to approve it
|
|
|
|
|
|
I didn't see that! I'll close this. |
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.
While using Cypress, I encountered a deprecated notice when following the official documentation for
cy.stub(object, method, replacerFn). Upon investigation, I found that this syntax has been deprecated in Sinon.JS since version 3.0.0. As Cypress is currently using Sinon.JS version 7.3.2(as per package.json), I determined that this was a deprecated specification.So I made changes in document:
cy.stub(object, method, replacerFn)syntax from the documentation.cy.stub(object, method).callsFake(replacerFn).These changes will help Cypress users write more up-to-date and future-proof test code, avoiding potential deprecation warnings or errors.
Please review and let me know if any further changes or clarifications are needed.