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

Changelog

Source

3.170.0 (2022-09-13)

Bug Fixes

scripts: skip files with stripped comments containing incorrect JavaScript (#3937) (bbb09f3)
util-endpoints: call multi-level functions from callFunction (#3929) (1209cb1)
util-endpoints: escape tilde when evaluating template (#3934) (5d7ef10)
util-endpoints: export parseArn from lib/aws (#3931) (1cee1f4)
util-endpoints: populate default params before checking for required values (#3928) (2561f60)
util-endpoints: return null in parseArn for some empty elements (#3935) (f8bc8b3)
util-endpoints: skip evaluation for arg of type number (#3936) (aecd894)

Features

client-customer-profiles: Added isUnstructured in response for Customer Profiles Integration APIs (a6fb5eb)
client-drs: Fixed the data type of lagDuration that is returned in Describe Source Server API (2a8f5f8)
client-ec2: Two new features for local gateway route tables: support for static routes targeting Elastic Network Interfaces and direct VPC routing. (9346a11)
client-evidently: This release adds support for the client-side evaluation - powered by AWS AppConfig feature. (a7d2b0e)
client-kendra: This release enables our customer to choose the option of Sharepoint 2019 for the on-premise Sharepoint connector. (a3f73d2)
client-transfer: This release introduces the ability to have multiple server host keys for any of your Transfer Family servers that use the SFTP protocol. (e09e302)
clients: update client endpoints as of 2022-09-13 (c90906b)

Readme

Source

@aws-sdk/eventstream-codec

FAQs

What is @aws-sdk/eventstream-codec?

Is @aws-sdk/eventstream-codec well maintained?

Last updated on 13 Sep 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install