Examples for Typescript type parameters for cy.intercept and cy.wait #5831
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
Merged
2 tasks
docs/api/commands/wait.mdx
Outdated
| cy.intercept('/activities/*').as('getActivities') | ||
|
|
||
| // As templated types: | ||
| cy.wait<CustomRequest, CustomResponse>('@getUsers').then( |
There was a problem hiding this comment.
The types here will need to match the ones above (and in the callback body):
cy.wait<UserReq, UserRes>(...
docs/api/commands/wait.mdx
Outdated
|
|
||
| // As inferred types, with type `Interception` available in `cypress/types/net-stubbing` | ||
| cy.wait('@getUsers').then( | ||
| ({ request, response }: Interception<CustomRequest, CustomResponse>) => { |
There was a problem hiding this comment.
Similarly to above, the types should match the above (and expected by the callback body):
...Interception<UserReq, UserRes>...
docs/api/commands/wait.mdx
Outdated
| } | ||
| ) | ||
|
|
||
| // When passing an array of aliases, types must me inferred: |
There was a problem hiding this comment.
Looks like a typo here :)
me → be
docs/api/commands/wait.mdx
Outdated
| cy.wait(['@getUsers', 'getActivities']).then( | ||
| ( | ||
| interceptions: Array< | ||
| Interception<UserReq | ActivityReq, UserRes, ActivityRes> |
There was a problem hiding this comment.
Small typo here:
Interception<UserReq | ActivityReq, UserRes | ActivityRes>
(note the comma → pipe)
|
@scottmcginness Thank you for your feedback! I'd gone back and forth on a few different edits, and missed updating some of them. Thanks for catching them! |
AtofStryker
approved these changes
Jun 5, 2024
mschile
approved these changes
Jun 6, 2024
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.
This covers changes introduced by: cypress-io/cypress#29508