waitForAnimations is not a valid option for .click TS type

[mariotsi]

Current behavior

cy.get('body').click({ waitForAnimations: false }) gets TS error because waitForAnimations is not a valid option on the Type even if is a suggested command https://docs.cypress.io/guides/references/error-messages.html#cy-failed-because-the-element-is-currently-animating

Desired behavior

cy.get('body').click({ waitForAnimations: false }) will not throw TS error

Versions

5.3.0 MacOS

[jennifer-shehane]

Yah, I can see how this error message is very confusing. This should be updated. You're meant to pass the waitForAnimations or animationDistanceThreshold options to your Cypress configuration - not within the command itself.

Disregard - this is accurate.

[jennifer-shehane]

Oh actually I see this waitForAnimations should work when passed to cy.click() but is not documented at all in the click document: https://on.cypress.io/click#Arguments

This is likely why the types don't reflect reality.

[lukeapage]

I noticed this and fixed it already in #8837

[jennifer-shehane]

Nice.

[mariotsi]

Thank you very much

[cypress-bot]

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

[cypress-bot]

Released in 6.1.0.

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