'autoEnd' does not exist in type 'Partial<LogConfig>'

[mccataldo]

Doing this:

// @ts-check
function someFn() {
  const log = Cypress.log({ autoEnd: false })
}

...results in this:

Argument of type '{ displayName: string; message: string; autoEnd: boolean; }' is not assignable to parameter of type 'Partial<LogConfig>'.
  Object literal may only specify known properties, and 'autoEnd' does not exist in type 'Partial<LogConfig>'.

[jennifer-shehane]

Yes, this appears to be missing. Feel free to open a PR. Check out our contributing doc.

[samueloakley]

@jennifer-shehane Looks like this is also missing from the API docs.
https://docs.cypress.io/api/cypress-api/cypress-log.html#Arguments
Is autoEnd documented somewhere else?

[jennifer-shehane]

No, I only found it used in our actual codebase.

[linkel]

I have created a PR to add the type, hope that's alright: #14220

[cypress-bot]

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

[cypress-bot]

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

[cypress-bot]

Released in 6.5.0.

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