Are the types in net-stubbing correct?

[bahmutov]

Cypress v5.3.0

Trying to write a test that shows how to modify the response from the server

cy.route2('styles.css', (req) => {
  req.reply((res) => {
    res.send(`${res.body}
      li {
        border: 1px solid pink;
      }
    `)
  })
})

Looking at IntelliSense suggested here

Ok, no JSDoc, fine, let's look at d.ts

So we have reply(interceptor) I guess, since we want to add to the response from the server

export type HttpResponseInterceptor = (res: CyHttpMessages.IncomingHttpResponse, send?: () => void) => void | Promise<void>

Ok, so res and optional send...

req.reply((res, send) => {
  console.log(res)
  console.log(send)

Ohhh, res.send is a function, there is no second parameter

[flotwig]

yeah, send was from an earlier version of the API design, it is always going to be undefined and should be removed:

cypress/packages/net-stubbing/lib/external-types.ts

Lines 69 to 70 in 857fcf9

	export type HttpResponseInterceptor = (res: CyHttpMessages.IncomingHttpResponse, send?: () => void) => void | Promise<void>

and these could use some tsdocs:

cypress/packages/net-stubbing/lib/external-types.ts

Lines 49 to 55 in 857fcf9

	export interface IncomingHttpRequest extends IncomingRequest {
	destroy(): void
	reply(interceptor?: StaticResponse | HttpResponseInterceptor): void
	reply(body: string | object, headers?: { [key: string]: string }): void
	reply(status: number, body?: string | object, headers?: { [key: string]: string }): void
	redirect(location: string, statusCode: number): void
	}

does that cover it?

[cypress-bot]

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

[cypress-bot]

Released in 5.4.0.

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