PipelineResponse interface

Package:

@azure/core-rest-pipeline

Metadata about a response received by the pipeline.

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.
headers	The HTTP response headers.
readableStreamBody	NODEJS ONLY The response body as a node.js Readable stream. Always undefined in the browser.
request	The request that generated this response.
status	The HTTP status code of the response.

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

browserStreamBody

BROWSER ONLY

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

browserStreamBody?: ReadableStream<Uint8Array>

Property Value

ReadableStream<Uint8Array>

headers

The HTTP response headers.

headers: HttpHeaders

Property Value

HttpHeaders

readableStreamBody

NODEJS ONLY

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

readableStreamBody?: ReadableStream

Property Value

ReadableStream

request

The request that generated this response.

request: PipelineRequest

Property Value

PipelineRequest

status

The HTTP status code of the response.

status: number

Property Value

number