Class Response

The result of a resource retrieval.

Hierarchy (View Summary)

Body
- Response

Index

Constructors

Properties

headers statusText url

Accessors

body bodyUsed ok status type

Methods

arrayBuffer blob bytes clone json text error json

Constructors

constructor

new Response(body?: BodyType, init?: ResponseInit): Response
Create a new retrieval result
Parameters
- body: BodyType = null
  the body of the result
- init: ResponseInit = {}
  additional metadata on the result of the retrieval
Returns Response
Overrides Body.constructor

Properties

`Readonly`headers

headers: Headers = ...

`Readonly`statusText

statusText: string = ''

`Readonly`url

url: string = null

Accessors

body

get body(): ReadableStream<Uint8Array>
Retrieve the contents of the body.

Returns ReadableStream<Uint8Array>
Inherited from Body.body

bodyUsed

get bodyUsed(): boolean
Check if the contents of the body have been consumed.

Returns boolean
Inherited from Body.bodyUsed

ok

get ok(): boolean
Check if this response is a result of a successful request.

Returns boolean

status

get status(): number
Get the HTTP status code, e.g. 200

Returns number

type

get type(): ResponseType
Get the ResponseType type of the response.

Returns ResponseType

Methods

arrayBuffer

arrayBuffer(): Promise<ArrayBufferLike>
Consume the body as ArrayBuffer.

Returns Promise<ArrayBufferLike>
Inherited from Body.arrayBuffer

blob

blob(): Promise<Blob>
Consume the contents of the body as a Blob.

Returns Promise<Blob>
Inherited from Body.blob

bytes

bytes(): Promise<Uint8Array>
Consume the contents of the body as Uint8Array.

Returns Promise<Uint8Array>
Inherited from Body.bytes

clone

clone(): Response
Create a deep copy of this response.

Returns Response

json

json(): Promise<any>
Consume the contents of the body as JSON.

Returns Promise<any>
Inherited from Body.json

text

text(): Promise<string>
Consume the contents of the body as text.

Returns Promise<string>
Inherited from Body.text

`Static`error

error(): Response
Create a new response that represents a network error.

Returns Response

`Static`json

json(data: any, init?: ResponseInit): Response
Create a new response, whose body is JSON-encoded data
Parameters
- data: any
  JSON-encoded body of the response
- Optionalinit: ResponseInit
  additional response metadata
Returns Response