@smithy/eventstream-codec

What is @smithy/eventstream-codec?

@smithy/eventstream-codec is an npm package designed to handle the encoding and decoding of event streams. It is part of the Smithy framework, which is used for building SDKs and other tools for AWS services. This package is particularly useful for working with AWS services that use event streams, such as AWS Transcribe or AWS Kinesis.

What are @smithy/eventstream-codec's main functionalities?

Encoding Event Streams

This feature allows you to encode an event stream into a binary format. The code sample demonstrates how to create an event and encode it using the EventStreamMarshaller.

const { EventStreamMarshaller } = require('@smithy/eventstream-codec');
const marshaller = new EventStreamMarshaller();
const event = { headers: {}, body: Buffer.from('example data') };
const encoded = marshaller.marshall(event);
console.log(encoded);

Decoding Event Streams

This feature allows you to decode a binary event stream back into its original format. The code sample shows how to decode an encoded event using the EventStreamMarshaller.

const { EventStreamMarshaller } = require('@smithy/eventstream-codec');
const marshaller = new EventStreamMarshaller();
const encoded = Buffer.from('example encoded data');
const event = marshaller.unmarshall(encoded);
console.log(event);

Other packages similar to @smithy/eventstream-codec

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 event streams. While it offers broader functionality than @smithy/eventstream-codec, it does not specifically focus on AWS event streams.

README

@smithy/eventstream-codec