fix(typedefs): Add type for autoEnd on LogConfig. #14220
Conversation
|
Thanks for taking the time to open a PR!
|
|
|
|
Are the three circleci failures expected? |
|
@linkel Yah those are some flaky tests. |
There was a problem hiding this comment.
It would be nice to have a comment here explaining what autoEnd is for, like the other props have.
I think this is only used to set autoEnd: false for .pause() command correct? The idea is that the command doesn't 'end' exactly.
Maybe understanding your use case for why you need to use this prop would be helpful.
|
@linkel Do you still have time to address the changes requested in this PR? We will have to close this PR due to inactivity otherwise. |
| @@ -5233,6 +5233,7 @@ declare namespace Cypress { | |||
| interface LogConfig extends Timeoutable { | |||
| /** The JQuery element for the command. This will highlight the command in the main window when debugging */ | |||
| $el: JQuery | |||
| autoEnd: boolean | |||
There was a problem hiding this comment.
Can you add a typedoc for this?
|
#15076 was now merged so this should be able to be closed |
|
closing as duplicate |
User facing changelog
Add type for autoEnd on LogConfig.
Additional details
I wanted to make a small contribution to Cypress and get the dev environment set up. The only change I made was adding the type.
Side notes about Cypress development:
After I made the change, I built the package and built the binary, and in my test project I pointed to the package in package.json and had to copy paste the binary into my cypress cache in order to successfully
yarnon my test project, otherwise it would try to download the binary online and fail since the version didn't exist.I also had to downgrade my node version to avoid a build error in node-sass.
How has the user experience changed?
Now it doesn't produce a type error and shows autoEnd correctly typed.
PR Tasks
type definitions?