Class Uint8ArrayResourceResponse

A ResourceResponse that uses a list of Uint8Arrays as the underlying data source.

Hierarchy

Uint8ArrayResourceResponse

Implements

IResourceResponse

Index

Constructors

constructor

Methods

Constructors

constructor

new Uint8ArrayResourceResponse(_metadata: IResourceMetadata, parts: Uint8Array[]): Uint8ArrayResourceResponse

Creates a new instance.

Parameters
- _metadata: IResourceMetadata
  
  The metadata about the resource
- parts: Uint8Array[]
  
  The resource body as an ordered list of Uint8Arrays.
Returns Uint8ArrayResourceResponse

Methods

abort

abort(): void

Implementation of IResourceResponse.abort

Abort any ongoing read operation with a ColibrioError with errorType set to ColibrioErrorType.ABORTED.

Returns void

asText

asText(): Promise<string>

Implementation of IResourceResponse.asText
Fetch the response body as text.
The supported text encodings are:
- UTF-8
- UTF-16LE
- UTF-16BE
Returns Promise<string>

asUint8Array

asUint8Array(): Promise<Uint8Array>

Implementation of IResourceResponse.asUint8Array

Fetch the response body as an Uint8Array. Note that the underlying ArrayBuffer may contain more data than just the body.

Returns Promise<Uint8Array>

getMetadata

getMetadata(): IResourceMetadata

Implementation of IResourceResponse.getMetadata

Get metadata about the resource.

Returns IResourceMetadata

getReadableStream

getReadableStream(): ReadableStream<Uint8Array>

Implementation of IResourceResponse.getReadableStream

Get the body as a ReadableStream.

Returns ReadableStream<Uint8Array>

Generated using TypeDoc