cy.server options not documented and not available in typescript definition file

[cm0s]

Current behavior:

cy.server command has a really useful option onAnyRequest. Which is really practical to inject headers or do other stuff.

Here is blog post describing how it can be used : https://medium.com/agilix/cypress-testing-include-custom-http-header-on-each-http-request-2b3693813e97

This option and apparently a few other ones are not documented and are also not available in the Typescript definition (cli/types/index.d.ts) (so cannot be used when using Typescript).

Desired behavior:

Having at least the Typescript definition updated, and if possible a line in the documentation about this option.

Steps to reproduce: (app code and test code)

 cy.server({
      onAnyRequest: function (route, proxy) {
         //...
      }
  });

This will not work when using typescript, it works with js.

Versions

Cypress 3.2.0

[jennifer-shehane]

We've added this as well as onAnyAbort and onAnyResponse to our documentation in this PR - cypress-io/cypress-documentation#1652

The TypeScript defs still are in progress of being written here: #4109

[cypress-bot]

The code for this is done in cypress-io/cypress#4109, 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.0.