Interface ByteStream

Byte payload stream of a framed read. The transforms buffer the remaining stream — mirroring the AWS SDK's SdkStreamMixin — and consume it, so each stream supports one buffering call.

interface ByteStream {
    transformToByteArray(): Promise<Uint8Array<ArrayBufferLike>>;
    transformToString(encoding?: string): Promise<string>;
    "[asyncIterator]"(): AsyncIterator<Uint8Array<ArrayBufferLike>, any, any>;
}

Hierarchy

AsyncIterable<Uint8Array>
- ByteStream

Index

Methods

transformToByteArray transformToString [asyncIterator]

Methods

transformToByteArray

transformToByteArray(): Promise<Uint8Array<ArrayBufferLike>>
Buffers the remaining payload chunks into one byte array.

Returns Promise<Uint8Array<ArrayBufferLike>>

transformToString

transformToString(encoding?: string): Promise<string>
Buffers the remaining payload chunks and decodes them as text.
Parameters
- Optionalencoding: string
Returns Promise<string>

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<Uint8Array<ArrayBufferLike>, any, any>
Returns AsyncIterator<Uint8Array<ArrayBufferLike>, any, any>
Inherited from AsyncIterable.[asyncIterator]