Module @aws-sdk/eventstream-serde-node

@aws-sdk/eventstream-serde-node

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

Functions

Const eventStreamSerdeProvider

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

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

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

readabletoIterable

readabletoIterable<T>(readStream: Readable): AsyncIterable<T>

- Defined in packages/eventstream-serde-node/src/utils.ts:11
Convert object stream piped in into an async iterable. This daptor should be deprecated when Node stream iterator is stable. Caveat: this adaptor won't have backpressure to inwards stream

Reference: https://nodejs.org/docs/latest-v11.x/api/stream.html#stream_readable_symbol_asynciterator

Type parameters
- T
Parameters
- readStream: Readable
Returns AsyncIterable<T>