@aws-sdk/eventstream-serde-browser

What is @aws-sdk/eventstream-serde-browser?

@aws-sdk/eventstream-serde-browser is a package within the AWS SDK for JavaScript that provides serialization and deserialization of event streams in a browser environment. This is particularly useful for handling AWS services that use event streams, such as AWS Transcribe or AWS Kinesis.

What are @aws-sdk/eventstream-serde-browser's main functionalities?

Serialization of Event Streams

This feature allows you to serialize an event stream into a format that can be transmitted over the network. The code sample demonstrates how to create an EventStreamMarshaller and use it to serialize an event.

const { EventStreamMarshaller } = require('@aws-sdk/eventstream-serde-browser');

const marshaller = new EventStreamMarshaller(utf8Encoder, utf8Decoder);
const event = { eventType: 'example', data: 'sample data' };
const serializedEvent = marshaller.marshall(event);
console.log(serializedEvent);

Deserialization of Event Streams

This feature allows you to deserialize an event stream received over the network back into a JavaScript object. The code sample demonstrates how to create an EventStreamMarshaller and use it to deserialize a binary event stream.

const { EventStreamMarshaller } = require('@aws-sdk/eventstream-serde-browser');

const marshaller = new EventStreamMarshaller(utf8Encoder, utf8Decoder);
const serializedEvent = new Uint8Array([/* some binary data */]);
const event = marshaller.unmarshall(serializedEvent);
console.log(event);

Other packages similar to @aws-sdk/eventstream-serde-browser

eventsource

The 'eventsource' package is a polyfill for the EventSource API, which allows you to receive server-sent events in a browser environment. While it does not provide serialization and deserialization of event streams, it is useful for handling real-time data streams from a server.

kinesis-client

The 'kinesis-client' package is a client library for AWS Kinesis, which provides functionalities for consuming and processing data streams. It includes features for handling event streams but is more focused on Kinesis-specific use cases compared to the general-purpose event stream serialization/deserialization provided by @aws-sdk/eventstream-serde-browser.

README

@aws-sdk/eventstream-serde-browser

An internal package

Usage

You probably shouldn't, at least directly.

Changelog

3.20.0 (2021-07-02)

Bug Fixes

• protocol_tests: add downlevel-dts script to aws-json-10 (#2540) (e77b926)
• replace prepublishOnly script with downlevel-dts (#2537) (63818a1)

Features

• clients: update clients as of 07/01/2021 (#2542) (ed301ba)