Generic for cy.request response body

[dimazuien]

Having a type of response body would be more convenient for TypeScript users

Currently, I see that request and response type annotations look like

request(url: string, body?: RequestBody): Chainable<Response>

interface Response {
  allRequestResponses: any[]
  body: any
  duration: number
  headers: { [key: string]: string }
  isOkStatusCode: boolean
  redirectedToUrl: string
  requestHeaders: { [key: string]: string }
  status: number
  statusText: string
}

If we change it to

request<T = any>(url: string, body?: RequestBody): Chainable<Response<T>>

interface Response<T = any> {
  allRequestResponses: any[]
  body: T
  duration: number
  headers: { [key: string]: string }
  isOkStatusCode: boolean
  redirectedToUrl: string
  requestHeaders: { [key: string]: string }
  status: number
  statusText: string
}

then a user will be able to specify the response body type in their code.

[jennifer-shehane]

We would be open to reviewing any Pull Requests made trying to improve the typings. Check out our contributing doc.

[dimazuien]

@jennifer-shehane, could you take a look at PR and let me know if there's anything else you need

[cypress-bot]

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

[cypress-bot]

Released in 7.5.0.

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