fix: remove unnecessary eventemitter2 type definitions from cy, Cypress #21286
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
|
Thanks for taking the time to open a PR!
|
1 task
tbiethman
reviewed
May 6, 2022
| @@ -87,3 +87,17 @@ namespace CypressActionCommandOptionTests { | |||
| cy.get('el').click({scrollBehavior: false}) | |||
| cy.get('el').click({scrollBehavior: true}) // $ExpectError | |||
| } | |||
|
|
|||
| namespace CyEventEmitterTests { | |||
There was a problem hiding this comment.
Can we put a comment here (or alongside the types themselves) explaining why we'd expect errors for waitFor/prependListener? Without context, these assertions seem a little random.
There was a problem hiding this comment.
I wrote the reason like below:
// `waitFor` doesn't exist in Node EventEmitter
// and it confuses the users with `cy.wait`
tbiethman
reviewed
May 6, 2022
cli/types/cypress-eventemitter.d.ts
Outdated
| off: CyActions | ||
| emit: EventEmitter2['emit'] | ||
| removeListener: EventEmitter2['removeListener'] | ||
| removeAllListeners: EventEmitter2['removeAllListeners'] |
There was a problem hiding this comment.
Our docs say that Cypress/cy are "standard Node event emitters": https://docs.cypress.io/api/events/catalog-of-events#Binding-to-Events
I'm wondering if we need to either:
- Change the wording there if we only intend to support a subset of the API
- Add more functions here to align with what Node's event emitter provides, like
addListener. The other missing APIs are probably less frequently used, but it's hard to say.
There was a problem hiding this comment.
I decided to change the type to Omit<EventEmitter2, 'waitFor'>.
Because other functions are harmless, they're really unlikely to be used in the real world cases, though.
tbiethman
approved these changes
May 9, 2022
ryanthemanuel
approved these changes
May 9, 2022
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.
User facing changelog
Remove unnecessary
eventemitter2type definitions fromcyandCypress.Additional details
eventemitter2definitions fromcyandCypress. Especially,cy.waitForis really confusing withcy.waitfor beginners.How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?cypress.schema.json?