cy.contains(content, options) syntax works, but missing in typescript declaration and not documented

[jodelasur]

Current behavior:

I tried cy.contains('content', {timeout: 6000}) and it works, but my IDE is complaining that "Argument types do not match parameters". I checked types/index.d.ts and didn't find a matching declaration.

I also checked the documentation and didn't find it referenced.

Desired behavior:

Just want to make this function signature official, as I happen to use it many times (and others might as well).

Versions

Cypress 3.3.2, Windows 10, Chrome 75

[bahmutov]

The typescript definition for cy.contains are included, see https://github.com/cypress-io/cypress/blob/develop/cli/types/index.d.ts#L577

I suggest restarting TS server in your IDE, sometimes it gets frozen?

[jodelasur]

Yes, I reviewed the definitions file, but the exact definition I'm looking for (with two arguments: a content string, and an optional options object) isn't there.

I think the params list of lines 577 and 586 should be extended as
(content: string | number | RegExp, options?: Partial<Loggable & Timeoutable>).

Then the documentation should add cy.contains(content, options) as another syntax.

I could make a pull request, but can only do so later in the week.

[jennifer-shehane]

Yes, this is a valid use of .contains() as noted in the code here: https://github.com/cypress-io/cypress/blob/develop/packages/driver/src/cy/commands/querying.coffee#L288 - the TypeScript defs should be updated.

I updated the docs here: cypress-io/cypress-documentation@7c1ce33

[cypress-bot]

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

[cypress-bot]

Released in 3.4.1.