HttpOperationResponse interface

Wrapper object for http request and response. Deserialized object is stored in the parsedBody property when the response body is received in JSON or XML.

Extends

Properties

blobBody

BROWSER ONLY

The response body as a browser Blob. Always undefined in node.js.

bodyAsText

The response body as text (string format)

parsedBody

The response body as parsed JSON or XML

parsedHeaders

The parsed HTTP response headers.

readableStreamBody

NODEJS ONLY

The response body as a node.js Readable stream. Always undefined in the browser.

Inherited Properties

headers

The HTTP response headers.

request

The raw request

status

The HTTP response status (e.g. 200)

Property Details

blobBody

BROWSER ONLY

The response body as a browser Blob. Always undefined in node.js.

blobBody?: Promise<Blob>

Property Value

Promise<Blob>

bodyAsText

The response body as text (string format)

bodyAsText?: null | string

Property Value

null | string

parsedBody

The response body as parsed JSON or XML

parsedBody?: any

Property Value

any

parsedHeaders

The parsed HTTP response headers.

parsedHeaders?: {[key: string]: any}

Property Value

{[key: string]: any}

readableStreamBody

NODEJS ONLY

The response body as a node.js Readable stream. Always undefined in the browser.

readableStreamBody?: ReadableStream

Property Value

ReadableStream

Inherited Property Details

headers

The HTTP response headers.

headers: HttpHeadersLike

Property Value

Inherited From HttpResponse.headers

request

The raw request

request: WebResourceLike

Property Value

Inherited From HttpResponse.request

status

The HTTP response status (e.g. 200)

status: number

Property Value

number

Inherited From HttpResponse.status