Module @aws-sdk/eventstream-serde-browser

@aws-sdk/eventstream-serde-browser

An internal package

Usage

You probably shouldn't, at least directly.

Index

References

Classes

EventStreamMarshaller

Interfaces

EventStreamMarshallerOptions

Functions

References

EventStreamMarshaller

Re-exports EventStreamMarshaller

EventStreamMarshallerOptions

Re-exports EventStreamMarshallerOptions

eventStreamSerdeProvider

Re-exports eventStreamSerdeProvider

iterableToReadableStream

Re-exports iterableToReadableStream

readableStreamtoIterable

Re-exports readableStreamtoIterable

Functions

Const eventStreamSerdeProvider

eventStreamSerdeProvider(options: { eventSigner: EventSigner | Provider<EventSigner>; utf8Decoder: Decoder; utf8Encoder: Encoder }): EventStreamMarshaller

- Defined in packages/eventstream-serde-browser/src/provider.ts:6
browser event stream serde utils provider

Parameters
- options: { eventSigner: EventSigner | Provider<EventSigner>; utf8Decoder: Decoder; utf8Encoder: Encoder }
  - eventSigner: EventSigner | Provider<EventSigner>
  - utf8Decoder: Decoder
  - utf8Encoder: Encoder
Returns EventStreamMarshaller

Const isReadableStream

isReadableStream(body: any): body is ReadableStream

- Defined in packages/eventstream-serde-browser/src/EventStreamMarshaller.ts:62
Parameters
- body: any
Returns body is ReadableStream

Const iterableToReadableStream

iterableToReadableStream<T>(asyncIterable: AsyncIterable<T>): ReadableStream<T>

- Defined in packages/eventstream-serde-browser/src/utils.ts:23
A util function converting async iterable to a ReadableStream.

Type parameters
- T
Parameters
- asyncIterable: AsyncIterable<T>
Returns ReadableStream<T>

Const readableStreamtoIterable

readableStreamtoIterable<T>(readableStream: ReadableStream<T>): AsyncIterable<T>

- Defined in packages/eventstream-serde-browser/src/utils.ts:5
A util function converting ReadableStream into an async iterable. Reference: https://jakearchibald.com/2017/async-iterators-and-generators/#making-streams-iterate

Type parameters
- T
Parameters
- readableStream: ReadableStream<T>
Returns AsyncIterable<T>