Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReadableStreamResourceResponse

A ResourceResponse that uses a ReadableStream as the underlying data source.

Hierarchy

  • ReadableStreamResourceResponse

Implements

Index

Constructors

Methods

Constructors

constructor

  • Creates new instance.

    Parameters

    • _metadata: IResourceMetadata

      The resource metadata.

    • _readableStream: ReadableStream<Uint8Array>

      The ReadableStream containing the body data.

    • Optional _abortCallback: () => void

      An optional callback that should abort the ReadableStream by enqueuing an ColibrioError with errorType set to ColibrioErrorType.ABORTED, or a DOMException with name set to "AbortError". If the ReadableStream has been retrieved from a fetch() response, an AbortController should be used to abort the ReadableStream. See: https://developer.mozilla.org/en-US/docs/Web/API/AbortController

        • (): void

        • Returns void

    Returns ReadableStreamResourceResponse

Methods

abort

  • abort(): void

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

    Returns void

asText

  • asText(): Promise<string>

  • Fetch the response body as text.

    The supported text encodings are:

    • UTF-8
    • UTF-16LE
    • UTF-16BE

    Returns Promise<string>

asUint8Array

  • asUint8Array(): Promise<Uint8Array>

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

    Returns Promise<Uint8Array>

getMetadata

getReadableStream

  • getReadableStream(): ReadableStream<Uint8Array>

Generated using TypeDoc