Class HttpResponse<BodyType>

A drop-in replacement for the standard Response class to allow additional features, like mocking the response Set-Cookie header.

Example

new HttpResponse('Hello world', { status: 201 })
HttpResponse.json({ name: 'John' })
HttpResponse.formData(form)

See

HttpResponse API reference

Type Parameters

BodyType extends DefaultBodyType

Hierarchy

FetchResponse
- HttpResponse

Constructors

constructor

new HttpResponse<BodyType extends DefaultBodyType>(
body?: NoInfer<BodyType> | null,
init?: HttpResponseInit,
): HttpResponse<BodyType>
Type Parameters
- BodyType extends DefaultBodyType
Parameters
- Optionalbody: NoInfer<BodyType> | null
- Optionalinit: HttpResponseInit
Returns HttpResponse<BodyType>
Overrides FetchResponse.constructor
- Defined in node_modules/msw/lib/core/HttpResponse-DlRR1D-f.d.mts:287

Properties

`Readonly`[bodyType]

"[bodyType]": BodyType

`Readonly`body

body: ReadableStream<any> | null

`Readonly`bodyUsed

bodyUsed: boolean

`Optional` `Readonly`cf

cf?: any

`Readonly`headers

headers: Headers

The headers read-only property of the with the response.

MDN Reference

`Readonly`ok

ok: boolean

The ok read-only property of the Response interface contains a Boolean stating whether the response was successful (status in the range 200-299) or not.

MDN Reference

`Readonly`redirected

redirected: boolean

The redirected read-only property of the Response interface indicates whether or not the response is the result of a request you made which was redirected.

MDN Reference

`Readonly`status

status: number

The status read-only property of the Response interface contains the HTTP status codes of the response.

MDN Reference

`Readonly`statusText

statusText: string

The statusText read-only property of the Response interface contains the status message corresponding to the HTTP status code in Response.status.

MDN Reference

type

type: "default" | "error"

The type read-only property of the Response interface contains the type of the response.

MDN Reference

`Readonly`url

url: string

The url read-only property of the Response interface contains the URL of the response.

MDN Reference

`Readonly`webSocket

webSocket: WebSocket | null

`Static` `Readonly`STATUS_CODES_WITH_REDIRECT

STATUS_CODES_WITH_REDIRECT: number[]

`Static` `Readonly`STATUS_CODES_WITHOUT_BODY

STATUS_CODES_WITHOUT_BODY: number[]

Response status codes for responses that cannot have body.

See

https://fetch.spec.whatwg.org/#statuses

Methods

arrayBuffer

arrayBuffer(): Promise<ArrayBuffer>
Returns Promise<ArrayBuffer>
Inherited from FetchResponse.arrayBuffer
- Defined in node_modules/@cloudflare/workers-types/index.d.ts:1947

blob

blob(): Promise<Blob>
Returns Promise<Blob>
Inherited from FetchResponse.blob
- Defined in node_modules/@cloudflare/workers-types/index.d.ts:1957

bytes

bytes(): Promise<Uint8Array<ArrayBufferLike>>
Returns Promise<Uint8Array<ArrayBufferLike>>
Inherited from FetchResponse.bytes
- Defined in node_modules/@cloudflare/workers-types/index.d.ts:1949

clone

clone(): Response
The clone() method of the Response interface creates a clone of a response object, identical in every way, but stored in a different variable.

MDN Reference

Returns Response
Inherited from FetchResponse.clone
- Defined in node_modules/@cloudflare/workers-types/index.d.ts:1982

formData

formData(): Promise<FormData>
Returns Promise<FormData>
Inherited from FetchResponse.formData
- Defined in node_modules/@cloudflare/workers-types/index.d.ts:1955

json

json<T>(): Promise<T>
Type Parameters
- T
Returns Promise<T>
Inherited from FetchResponse.json
- Defined in node_modules/@cloudflare/workers-types/index.d.ts:1953

text

text(): Promise<string>
Returns Promise<string>
Inherited from FetchResponse.text
- Defined in node_modules/@cloudflare/workers-types/index.d.ts:1951

`Static`arrayBuffer

arrayBuffer<BodyType extends ArrayBuffer | SharedArrayBuffer>(
body?: BodyType,
init?: HttpResponseInit,
): HttpResponse<BodyType>
Create a Response with an ArrayBuffer body.
Type Parameters
- BodyType extends ArrayBuffer | SharedArrayBuffer
Parameters
- Optionalbody: BodyType
- Optionalinit: HttpResponseInit
Returns HttpResponse<BodyType>
Example
```
const buffer = new ArrayBuffer(3)
const view = new Uint8Array(buffer)
view.set([1, 2, 3])

HttpResponse.arrayBuffer(buffer)
```
- Defined in node_modules/msw/lib/core/HttpResponse-DlRR1D-f.d.mts:326

`Static`error

error(): HttpResponse<any>
Returns HttpResponse<any>
Overrides FetchResponse.error
- Defined in node_modules/msw/lib/core/HttpResponse-DlRR1D-f.d.mts:288

`Static`formData

formData(body?: FormData, init?: HttpResponseInit): HttpResponse<FormData>
Create a Response with a FormData body.
Parameters
- Optionalbody: FormData
- Optionalinit: HttpResponseInit
Returns HttpResponse<FormData>
Example
```
const data = new FormData()
data.set('name', 'Alice')

HttpResponse.formData(data)
```
- Defined in node_modules/msw/lib/core/HttpResponse-DlRR1D-f.d.mts:335

`Static`html

html<BodyType extends string>(
body?: BodyType | null,
init?: HttpResponseInit,
): HttpResponse<BodyType>
Create a Response with a Content-Type: "text/html" body.
Type Parameters
- BodyType extends string
Parameters
- Optionalbody: BodyType | null
- Optionalinit: HttpResponseInit
Returns HttpResponse<BodyType>
Example
```
HttpResponse.html(`<p class="author">Jane Doe</p>`)
HttpResponse.html(`<main id="abc-123">Main text</main>`, { status: 201 })
```
- Defined in node_modules/msw/lib/core/HttpResponse-DlRR1D-f.d.mts:316

`Static`isConfigurableStatusCode

isConfigurableStatusCode(status: number): boolean
Parameters
- status: number
Returns boolean
Inherited from FetchResponse.isConfigurableStatusCode
- Defined in node_modules/@mswjs/interceptors/lib/node/index.d.mts:35

`Static`isRedirectResponse

isRedirectResponse(status: number): boolean
Parameters
- status: number
Returns boolean
Inherited from FetchResponse.isRedirectResponse
- Defined in node_modules/@mswjs/interceptors/lib/node/index.d.mts:36

`Static`isResponseWithBody

isResponseWithBody(status: number): boolean
Returns a boolean indicating whether the given response status code represents a response that can have a body.
Parameters
- status: number
Returns boolean
Inherited from FetchResponse.isResponseWithBody
- Defined in node_modules/@mswjs/interceptors/lib/node/index.d.mts:41

`Static`json

json<BodyType extends JsonBodyType>(
body?: NoInfer<BodyType> | null,
init?: HttpResponseInit,
): HttpResponse<BodyType>
Create a Response with a Content-Type: "application/json" body.
Type Parameters
- BodyType extends JsonBodyType
Parameters
- Optionalbody: NoInfer<BodyType> | null
- Optionalinit: HttpResponseInit
Returns HttpResponse<BodyType>
Example
```
HttpResponse.json({ firstName: 'John' })
HttpResponse.json({ error: 'Not Authorized' }, { status: 401 })
```
Overrides FetchResponse.json
- Defined in node_modules/msw/lib/core/HttpResponse-DlRR1D-f.d.mts:302

`Static`parseRawHeaders

parseRawHeaders(rawHeaders: string[]): Headers
Parses the given raw HTTP headers into a Fetch API Headers instance.
Parameters
- rawHeaders: string[]
Returns Headers
Inherited from FetchResponse.parseRawHeaders
- Defined in node_modules/@mswjs/interceptors/lib/node/index.d.mts:46

`Static`redirect

redirect(url: string, status?: number): Response
Parameters
- url: string
- Optionalstatus: number
Returns Response
Inherited from FetchResponse.redirect
- Defined in node_modules/@cloudflare/workers-types/index.d.ts:1968

`Static`setUrl

setUrl(url: string | undefined, response: Response): void
Parameters
- url: string | undefined
- response: Response
Returns void
Inherited from FetchResponse.setUrl
- Defined in node_modules/@mswjs/interceptors/lib/node/index.d.mts:42

`Static`text

text<BodyType extends string>(
body?: NoInfer<BodyType> | null,
init?: HttpResponseInit,
): HttpResponse<BodyType>
Create a Response with a Content-Type: "text/plain" body.
Type Parameters
- BodyType extends string
Parameters
- Optionalbody: NoInfer<BodyType> | null
- Optionalinit: HttpResponseInit
Returns HttpResponse<BodyType>
Example
```
HttpResponse.text('hello world')
HttpResponse.text('Error', { status: 500 })
```
- Defined in node_modules/msw/lib/core/HttpResponse-DlRR1D-f.d.mts:295

`Static`xml

xml<BodyType extends string>(
body?: BodyType | null,
init?: HttpResponseInit,
): HttpResponse<BodyType>
Create a Response with a Content-Type: "application/xml" body.
Type Parameters
- BodyType extends string
Parameters
- Optionalbody: BodyType | null
- Optionalinit: HttpResponseInit
Returns HttpResponse<BodyType>
Example
```
HttpResponse.xml(`<user name="John" />`)
HttpResponse.xml(`<article id="abc-123" />`, { status: 201 })
```
- Defined in node_modules/msw/lib/core/HttpResponse-DlRR1D-f.d.mts:309

Class HttpResponse<BodyType>

Example

See

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns HttpResponse<BodyType>

Properties

Readonly[bodyType]

Readonlybody

ReadonlybodyUsed

Optional Readonlycf

Readonlyheaders

Readonlyok

Readonlyredirected

Readonlystatus

ReadonlystatusText

type

Readonlyurl

ReadonlywebSocket

Static ReadonlySTATUS_CODES_WITH_REDIRECT

Static ReadonlySTATUS_CODES_WITHOUT_BODY

See

Methods

arrayBuffer

Returns Promise<ArrayBuffer>

blob

Returns Promise<Blob>

bytes

Returns Promise<Uint8Array<ArrayBufferLike>>

clone

Returns Response

formData

Returns Promise<FormData>

json

Type Parameters

Returns Promise<T>

text

Returns Promise<string>

StaticarrayBuffer

Type Parameters

Parameters

Returns HttpResponse<BodyType>

Example

Staticerror

Returns HttpResponse<any>

StaticformData

Parameters

Returns HttpResponse<FormData>

Example

Statichtml

Type Parameters

Parameters

Returns HttpResponse<BodyType>

Example

StaticisConfigurableStatusCode

Parameters

Returns boolean

StaticisRedirectResponse

Parameters

Returns boolean

StaticisResponseWithBody

Parameters

Returns boolean

Staticjson

Type Parameters

Parameters

Returns HttpResponse<BodyType>

Example

StaticparseRawHeaders

Parameters

Returns Headers

Staticredirect

`Readonly`[bodyType]

`Readonly`body

`Readonly`bodyUsed

`Optional` `Readonly`cf

`Readonly`headers

`Readonly`ok

`Readonly`redirected

`Readonly`status

`Readonly`statusText

`Readonly`url

`Readonly`webSocket

`Static` `Readonly`STATUS_CODES_WITH_REDIRECT

`Static` `Readonly`STATUS_CODES_WITHOUT_BODY

`Static`arrayBuffer

`Static`error

`Static`formData

`Static`html

`Static`isConfigurableStatusCode

`Static`isRedirectResponse

`Static`isResponseWithBody

`Static`json

`Static`parseRawHeaders

`Static`redirect

`Static`setUrl

`Static`text

`Static`xml