Property 'state' does not exist on type 'Chainable<undefined>'

[lifeiscontent]

Current behavior:

cy.state doesn't exist on typescript definitions

Desired behavior:

cy.state exists on typescript definitions

Steps to reproduce: (app code and test code)

just check cy.state and see its not defined

Versions

Cypress Latest

[jennifer-shehane]

Previous docs issue for cy.state cypress-io/cypress-documentation#108

[amitguptagwl]

Property 'state' does not exist on type 'cy'.

/// <reference types="cypress" />
// @ts-check
exports.HomePage = () => {
    return cy.state("currentPage");
}

[sainthkh]

We can define it like below:

interface State {
  (property: 'document'): Document
  (property: 'window'): Cypress.AUTWindow
  (property: 'runnable'): any
  // etc. etc.
  (property: string): any
}

But the problem is that it's not sure cy.state should be revealed or not. => Related link

[ShaneHudson]

For anyone that is trying to use @sainthkh's answer, use it like this:

  interface cy {
    state: State;
  }

[kdp88]

@ShaneHudson where would I put this interface, currently I have it in the index.d.ts but my spec file still gives ts error, im thinking i gotta add it to commands.ts?

[Keysox]

We're using:

declare global {
  namespace Cypress {
    interface Chainable {
      state(state: any): any
    }
  }
}