@aws-sdk/eventstream-codec

What is @aws-sdk/eventstream-codec?

The @aws-sdk/eventstream-codec npm package is designed to handle AWS event streams, providing utilities for encoding and decoding messages in the event stream format used by AWS services. This package is particularly useful when working with AWS services that utilize event streams for real-time data processing.

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

Encoding messages

This feature allows you to encode messages into the AWS event stream format. The `marshall` function takes a message object with headers and a body and returns a Buffer of the encoded message.

const { marshall } = require('@aws-sdk/eventstream-codec');
const message = {
  headers: {
    ':message-type': {
      type: 'string',
      value: 'event'
    },
    ':event-type': {
      type: 'string',
      value: 'Records'
    }
  },
  body: Buffer.from('Hello, this is a test message')
};
const encodedMessage = marshall(message);

Decoding messages

This feature enables the decoding of messages from the AWS event stream format. The `unmarshall` function takes a Buffer of an encoded message and returns an object representing the decoded message, including headers and body.

const { unmarshall } = require('@aws-sdk/eventstream-codec');
const encodedMessage = Buffer.from(/* previously encoded message */);
const decodedMessage = unmarshall(encodedMessage);
console.log(decodedMessage);

Other packages similar to @aws-sdk/eventstream-codec

event-stream

The 'event-stream' package provides utilities for creating and manipulating streams of data in Node.js. While it offers general stream handling capabilities, it does not specifically target AWS event stream formats like @aws-sdk/eventstream-codec, making it less specialized for AWS event stream handling.

aws-event-stream

The 'aws-event-stream' package is another tool for handling AWS event streams. It provides similar functionalities to @aws-sdk/eventstream-codec, focusing on encoding and decoding AWS event stream messages. The main difference may lie in the specific implementations and additional utilities provided by each package.

README

@aws-sdk/eventstream-codec

Changelog

3.374.0 (2023-07-20)

Bug Fixes

• packages: fix migrated package imports (#4990) (d800f78)

Features

• client-codecatalyst: This release adds support for updating and deleting spaces and projects in Amazon CodeCatalyst. It also adds support for creating, getting, and deleting source repositories in CodeCatalyst projects. (05a9f89)
• client-connectcases: This release adds the ability to assign a case to a queue or user. (f47d6f4)
• client-lex-models-v2: This release updates type for Channel field in SessionSpecification and UtteranceSpecification (1f77d0a)
• client-route53resolver: This release adds support for Route 53 On Outposts, a new feature that allows customers to run Route 53 Resolver and Resolver endpoints locally on their Outposts. (8acc64c)
• client-s3: Improve performance of S3 clients by simplifying and optimizing endpoint resolution. (72eb598)
• client-sagemaker-featurestore-runtime: Cross account support for SageMaker Feature Store (b0593ab)
• client-sagemaker: Cross account support for SageMaker Feature Store (e4918c1)
• client-securitylake: Adding support for Tags on Create and Resource Tagging API. (596636d)
• client-transcribe: Added API argument --toxicity-detection to startTranscriptionJob API, which allows users to view toxicity scores of submitted audio. (9e7552a)
• smithy-client: update client defaults provider (830cb06)