CompatResponse interface

Package:

@azure/core-http-compat

Http Response that is compatible with the core-v1(core-http).

Extends

Omit<FullOperationResponse, "request" | "headers">

Properties

headers	A collection of HTTP header key/value pairs.
request	A description of a HTTP request to be made to a remote server.

Inherited Properties

blobBody	BROWSER ONLY The response body as a browser Blob. Always undefined in node.js.
bodyAsText	The response body as text (string format)
browserStreamBody	BROWSER ONLY The response body as a browser ReadableStream. Always undefined in node.js.
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.
status	The HTTP status code of the response.

Property Details

headers

A collection of HTTP header key/value pairs.

headers: HttpHeadersLike

Property Value

HttpHeadersLike

request

A description of a HTTP request to be made to a remote server.

request: WebResourceLike

Property Value

WebResourceLike

Inherited Property Details

blobBody

BROWSER ONLY

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

blobBody?: Promise<Blob>

Property Value

Promise<Blob>

Inherited From Omit.blobBody

bodyAsText

The response body as text (string format)

bodyAsText?: null | string

Property Value

null | string

Inherited From Omit.bodyAsText

browserStreamBody

BROWSER ONLY

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

browserStreamBody?: ReadableStream<Uint8Array>

Property Value

ReadableStream<Uint8Array>

Inherited From Omit.browserStreamBody

parsedBody

The response body as parsed JSON or XML.

parsedBody?: any

Property Value

any

Inherited From Omit.parsedBody

parsedHeaders

The parsed HTTP response headers.

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

Property Value

{[key: string]: unknown}

Inherited From Omit.parsedHeaders

readableStreamBody

NODEJS ONLY

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

readableStreamBody?: ReadableStream

Property Value

ReadableStream

Inherited From Omit.readableStreamBody

status

The HTTP status code of the response.

status: number

Property Value

number

Inherited From Omit.status