@aws-sdk/eventstream-serde-universal

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

@aws-sdk/eventstream-serde-universal is a package within the AWS SDK for JavaScript that provides serialization and deserialization of event streams. This is particularly useful for handling streaming data in AWS services like AWS Transcribe, AWS Kinesis, and others that use event streams.

What are @aws-sdk/eventstream-serde-universal'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 instance of EventStreamMarshaller and serialize an event.

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

const marshaller = new EventStreamMarshaller();
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 its original format. The code sample demonstrates how to create an instance of EventStreamMarshaller and deserialize an event.

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

const marshaller = new EventStreamMarshaller();
const serializedEvent = /* some serialized event data */;
const event = marshaller.unmarshall(serializedEvent);
console.log(event);

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

event-stream

The 'event-stream' package is a toolkit for working with streams in Node.js. It provides a variety of utilities for creating and manipulating streams, including serialization and deserialization. While it is more general-purpose compared to @aws-sdk/eventstream-serde-universal, it can be used for similar tasks involving event streams.

kinesis-client-library

The 'kinesis-client-library' package is specifically designed for working with AWS Kinesis streams. It provides higher-level abstractions for consuming and processing Kinesis streams, including serialization and deserialization of event data. It is more specialized compared to @aws-sdk/eventstream-serde-universal, which is more general-purpose for AWS event streams.

README

@aws-sdk/eventstream-serde-universal

An internal package

Usage

You probably shouldn't, at least directly.

Changelog

3.22.0 (2021-07-16)

Bug Fixes

• clients: link to Hash Interface (#2573) (bb7b3ed)
• clients: prefix dist/ for typesVersions TS<4 (#2580) (dff5cd4)
• codegen: fix detection of -s for generate-clients (#2588) (c989b76)
• node-http-handler: throw meaningful errors in H2 events (#2568) (160aeba)

Features

• clients: update clients as of 07/16/2021 (#2591) (f231e7c)
• credential-provider-sso: support sso credential when resolving shared credential file (#2583) (9480e70)
• postinstall-node-version-check: util to show NodeDeprecationWarning (#2585) (08c0342)