Skip to main content
The response for a FetchRequest.

Implements

  • Iterable<[string, string]>

Accessors

body

The response body, or null if there was no body.

Returns

null | Readonly<Uint8Array>

Source

utils/fetch.ts:891

bodyJson

The response body, decoded as JSON. An error is thrown if the body is invalid JSON-encoded data or if there was no body.

Returns

any

Source

utils/fetch.ts:916

bodyText

The response body as a UTF-8 encoded string, or the empty string (i.e. "") if there was no body. An error is thrown if the body is invalid UTF-8 data.

Returns

string

Source

utils/fetch.ts:900

headers

The response headers. All keys are lower-case.

Returns

Record<string, string>

Source

utils/fetch.ts:884

request

The request made for this response.

Returns

null | FetchRequest

Source

utils/fetch.ts:1033

statusCode

The response status code.

Returns

number

Source

utils/fetch.ts:870

statusMessage

The response status message.

Returns

string

Source

utils/fetch.ts:877

Methods

assertOk()

Throws a SERVER_ERROR if this response is not ok.

Returns

void

Throws

If the response is not ok.

Source

utils/fetch.ts:1049

getHeader()

Get the header value for key, ignoring case.

Parameters

ParameterTypeDescription
keystringThe header key to retrieve.

Returns

string The header value.

Source

utils/fetch.ts:1016

hasBody()

Returns true if the response has a body.

Returns

this is FetchResponse & Object True if the response has a body.

Throws

If the body is invalid UTF-8 data.

Source

utils/fetch.ts:1026

makeServerError()

Return a Response with matching headers and body, but with an error status code (i.e. 599) and message with an optional error.

Parameters

ParameterTypeDescription
message?stringThe error message to use.
error?ErrorThe error to use.

Returns

FetchResponse The error response.

Source

utils/fetch.ts:975

ok()

Returns true if this response was a success statusCode.

Returns

boolean

Source

utils/fetch.ts:1040

throwThrottleError()

If called within a request.processFunc call, causes the request to retry as if throttled for stall milliseconds.

Parameters

ParameterTypeDescription
message?stringThe error message to use.
stall?numberThe number of milliseconds to stall before retrying.

Returns

never

Throws

If stall is not a non-negative integer.

Source

utils/fetch.ts:996