Provide strong types for 'invoke' command (#4022) #4907
Conversation
|
|
|
We don't consider type changes as breaking changes since the typescript checks can always be disabled. |
jennifer-shehane
requested review from
flotwig,
bahmutov,
kuceb,
dmtrKovalenko and
tgriesser
mayfieldiv
force-pushed
the
issue-4022
branch
2 times, most recently
from
8157e28 to
3607df0
Compare
mayfieldiv
changed the title
| * | ||
| * @see https://on.cypress.io/invoke | ||
| */ | ||
| invoke(functionName: keyof Subject, ...args: any[]): Chainable<Subject> // don't have a way to express return types yet | ||
| invoke< | ||
| TActualSubject extends (Subject extends Node | Node[] ? JQuery<Subject> : Subject), |
There was a problem hiding this comment.
After reading through #806 (comment) and looking at the implementation of invoke, I added handling for the jQuery wrapping invoke does on its inputs
There was a problem hiding this comment.
can you add an example here to the jsdoc for the user to understand the API method
There was a problem hiding this comment.
Added a couple examples based on the docs
|
hmm, seems the types of arguments to jQuery element are too strict, these tests in Kitchensink are failing https://circleci.com/gh/cypress-io/cypress/144563 where the test is simply cy.get('.trigger-input-range')
.invoke('val', 25) |
|
I will revert the merged commit and will reopen the issue, don't want to release a breaking type change. Seems like the type is close, but stops at a single argument there |
…io#4907) * add strong return type to 'invoke' command * refactor invoke for clarity. use dtslint tests * add strong args types using typescript 3.0+ features * handle invoke's jquery wrapping of its input * move invoke tests to namespace * add example to jsdocs of 'invoke'
…ypress-io#4907)" This reverts commit 15685db. The type for `invoke` command seems to break jQuery method that take an argument like ```js cy.get('.trigger-input-range') .invoke('val', 25) ```
Closes #4022
Provides strong typing for arguments and return type of
invokecommand. Also ensuresfunctionNameis the key of a function on theSubject.Since typing becomes more strict, this is technically a breaking change, but isn't considered a big deal (see #4907 (comment))
Pre-merge Tasks