Skip to content

Fix types for cy.dblclick and cy.rightclick#5618

Merged
jennifer-shehane merged 4 commits intocypress-io:developfrom
warpdesign:patch-1
Nov 7, 2019
Merged

Fix types for cy.dblclick and cy.rightclick#5618
jennifer-shehane merged 4 commits intocypress-io:developfrom
warpdesign:patch-1

Conversation

@warpdesign
Copy link
Contributor

@warpdesign warpdesign commented Nov 7, 2019

User facing changelog

This PR adds the missing call signatures for dblclick and rightclick in the index.d.ts file.

Additional details

Without this change, dblclick and rightclick could only be used with the first call signature (rightclick(options?) in a TypeScript file.

How has the user experience changed?

These two call signatures where missing for rightclick and dblclick: only the `rightclick(options?: Partial<ClickOptions>): Chainable<Subject> ` one was present.

See cypress-io#5617
@cypress-bot
Copy link
Contributor

cypress-bot bot commented Nov 7, 2019

Thanks for the contribution! Below are some guidelines Cypress uses when doing PR reviews.

  • Please write [WIP] in the title of your Pull Request if your PR is not ready for review - someone will review your PR as soon as the [WIP] is removed.
  • Please familiarize yourself with the PR Review Checklist and feel free to make updates on your PR based on these guidelines.

PR Review Checklist

If any of the following requirements can't be met, leave a comment in the review selecting 'Request changes', otherwise 'Approve'.

User Experience

  • The feature/bugfix is self-documenting from within the product.
  • The change provides the end user with a way to fix their problem (no dead ends).

Functionality

  • The code works and performs its intended function with the correct logic.
  • Performance has been factored in (for example, the code cleans up after itself to not cause memory leaks).
  • The code guards against edge cases and invalid input and has tests to cover it.

Maintainability

  • The code is readable (too many nested 'if's are a bad sign).
  • Names used for variables, methods, etc, clearly describe their function.
  • The code is easy to understood and there are relevant comments explaining.
  • New algorithms are documented in the code with link(s) to external docs (flowcharts, w3c, chrome, firefox).
  • There are comments containing link(s) to the addressed issue (in tests and code).

Quality

  • The change does not reimplement code.
  • There's not a module from the ecosystem that should be used instead.
  • There is no redundant or duplicate code.
  • There are no irrelevant comments left in the code.
  • Tests are testing the code’s intended functionality in the best way possible.

Internal

  • The original issue has been tagged with a release in ZenHub.

@CLAassistant
Copy link

CLAassistant commented Nov 7, 2019

CLA assistant check
All committers have signed the CLA.

@flotwig flotwig requested a review from kuceb November 7, 2019 19:24
@flotwig flotwig changed the title Patch 1 Fix types for cy.dblclick and cy.rightclick Nov 7, 2019
@jennifer-shehane jennifer-shehane merged commit 9aeadbd into cypress-io:develop Nov 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

rightclick: wrong description in index.d.ts?

4 participants