@aws-sdk/eventstream-serde-node

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

@aws-sdk/eventstream-serde-node is a package within the AWS SDK for JavaScript that provides serialization and deserialization of event streams for Node.js. 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-node'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-node');
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-node');
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-node

event-stream

The 'event-stream' package is a toolkit for working with streams in Node.js. It provides utilities for creating and manipulating streams, including event streams. While it offers broader stream manipulation capabilities, it does not specifically focus on AWS event stream serialization and deserialization like @aws-sdk/eventstream-serde-node.

kinesis-client-library

The 'kinesis-client-library' package is designed for working with AWS Kinesis streams. It provides higher-level abstractions for consuming and processing Kinesis streams. While it is more specialized for Kinesis, it does not offer the general event stream serialization and deserialization capabilities provided by @aws-sdk/eventstream-serde-node.

README

@aws-sdk/eventstream-serde-node

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)