Why can I use cy.waitFor()?

[Serhansolo]

Current behavior

I noticed that I can use cy.waitFor(string) to wait for a cypress alias. I can't find any documentation on the matter. While there is a good page for cy.wait(string) (https://docs.cypress.io/api/commands/wait). While this oddly seems to work whilst waiting for an API stub to resolve. I'm not sure if it is the expected behavior for wait().

My IDE tells me that cy.waitFor() is a valid function to use. I just don't think it is. It looks like it's wrongly exposed in the typing files.

Desired behavior

I would not expect the waitFor() function to show in my IDE as a possible method. Since it is not described in the documentation. OR it should be described in the documentation with the intended behavior.

Test code to reproduce

Just write cy.wait in any IDE enabled with code hinting and typescript for cypress.

Cypress Version

9.5.0

Other

Or this all has to do with my IDE setup, although I can't imagine it is since it happens with multiple (if not all) team members...

[emilyrohrbough]

cy.waitFor is not an out-of-the box Cypress command and I just validated we do not provide types for this function. Does your project by chance leverage a plugin that might be adding this command & its corresponding types?

[mike-mccormick]

@emilyrohrbough I can maybe help clarify this one; I'm seeing too but following the definition shows it's coming from eventemitter2:

other methods in it's d.ts also show with intellesense:

Spitballing, but any chance it's coming through EventEmitter?

[cypress-bot]

The code for this is done in cypress-io/cypress#21286, but has yet to be released.
We'll update this issue and reference the changelog when it's released.

[cypress-bot]

Released in 9.7.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v9.7.0, please open a new issue.