Documentation and types do not reflect behaviour of then when returning element

[OliverJAsh]

Current behavior

Given

const event = new Event('click');

cy.get('div')
  .then((el$) => {
    const el: HTMLDivElement = el$[0];
    return el;
  })
  .then((el) => el.dispatchEvent(event));

This doesn't produce a TypeScript type error.

At runtime it throws an exception:

TypeError: el.dispatchEvent is not a function

This appears to happen because el is not actually a HTMLDivElement, despite what TypeScript thinks. It's actually a JQuery wrapped element.

Desired behavior

• This should produce a type error at compile time (i.e. the types need to reflect the runtime behaviour).
• This "wrapping" behaviour should be documented on the page for then.

Test code to reproduce

See above

Versions

Latest TS and Cypress

[jennifer-shehane]

Feel free to open a PR here and in the docs. Check out our contributing doc.

[cypress-bot]

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

[cypress-bot]

Released in 7.0.0.

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