Fix the cy.stub type signature

[NoriSte]

Hi
The cy.stub TypeScript signature is wrong. I started from your Add example to cy.stub() for stubbing window.prompt behavior but, with the same code, I get an error form TypeSctypt

Property 'returns' does not exist on type 'Agent<SinonStub<any[], any>>'.

see the screenshot of the code

In the above screenshot, I show you how everything works fine with the log, as and withArgs functions added by the Agent type.

The problem is that the cy.stub function returns a Agent<sinon.SinonStub> but the Agent itself doesn't extend the sinon.SinonStub type.

Since the code

cy.stub(win, "prompt").returns("yes");

works perfectly in a standard JavaScript spec file, the error is in the TypeScript definitions only.

The easiest solution I found is to rename the Agent type to SinonSpyAgent and declare a new type Agent with the following signature

type Agent<T> = SinonSpyAgent<T> & T

I made it because both the cy.stub and cy.spy functions return the Agent type.

Doing so:

• the cy.stub and cy.spy signatures don't change
• TypeScript no more throws an error

Let me know if I missed something and thank you for all, Cypress is simply amazing 😉

[CLAassistant]

All committers have signed the CLA.

[jennifer-shehane]

There are some failures in our TS linter. @NoriSte Can you look into these?

Error: /root/cypress/cli/types/index.d.ts:1811:1
ERROR: 1811:1   no-trailing-whitespace  trailing whitespace
ERROR: 1812:33  expect                  TypeScript@next compile error: 
Type 'T' does not satisfy the constraint 'SinonSpy'.

/root/cypress/cli/types/tests/actions.ts:6:31
ERROR: 6:31     expect                  TypeScript@next compile error: 
Parameter 'text' implicitly has an 'any' type.
ERROR: 7:3      expect                  Expected type to be:
  string
got:
  any
ERROR: 10:29    expect                  TypeScript@next compile error: 
Parameter 'text' implicitly has an 'any' type.
ERROR: 11:3     expect                  Expected type to be:
  string
got:
  any

    at /root/cypress/cli/node_modules/dtslint/bin/index.js:189:19
    at Generator.next (<anonymous>)
    at fulfilled (/root/cypress/cli/node_modules/dtslint/bin/index.js:5:58)
    at <anonymous>

[NoriSte]

Sorry @jennifer-shehane, I've just fixed it

[cypress-bot]

Released in 3.3.2.