@aws-sdk/eventstream-serde-config-resolver

What is @aws-sdk/eventstream-serde-config-resolver?

@aws-sdk/eventstream-serde-config-resolver is a package within the AWS SDK for JavaScript that provides utilities for resolving configuration related to event stream serialization and deserialization. This is particularly useful when working with AWS services that use event streams, such as AWS Transcribe or Kinesis.

What are @aws-sdk/eventstream-serde-config-resolver's main functionalities?

Event Stream Serialization

This feature allows you to resolve the configuration for event stream serialization. The `resolveEventStreamSerdeConfig` function takes an object with an `eventStreamSerdeProvider` property, which provides the serialization and deserialization logic.

const { resolveEventStreamSerdeConfig } = require('@aws-sdk/eventstream-serde-config-resolver');

const config = resolveEventStreamSerdeConfig({
  eventStreamSerdeProvider: () => ({
    serialize: (input) => {/* serialization logic */},
    deserialize: (output) => {/* deserialization logic */}
  })
});

console.log(config);

Custom Serialization Logic

This feature demonstrates how to provide custom serialization and deserialization logic. The `customSerdeProvider` object defines how to serialize and deserialize event stream data, and this is passed to the `resolveEventStreamSerdeConfig` function.

const { resolveEventStreamSerdeConfig } = require('@aws-sdk/eventstream-serde-config-resolver');

const customSerdeProvider = {
  serialize: (input) => Buffer.from(JSON.stringify(input)),
  deserialize: (output) => JSON.parse(output.toString())
};

const config = resolveEventStreamSerdeConfig({
  eventStreamSerdeProvider: () => customSerdeProvider
});

console.log(config);

Other packages similar to @aws-sdk/eventstream-serde-config-resolver

aws-sdk

The `aws-sdk` package is the official AWS SDK for JavaScript. It provides a comprehensive set of tools for interacting with AWS services, including event stream handling. However, it is a much larger package and includes a wide range of functionalities beyond just event stream serialization and deserialization.

kinesis-client-library

The `kinesis-client-library` package is designed specifically for working with Amazon Kinesis streams. It includes utilities for processing and managing Kinesis data streams, including serialization and deserialization of event streams. It is more specialized compared to `@aws-sdk/eventstream-serde-config-resolver`.

aws-sdk-client-mock

The `aws-sdk-client-mock` package is used for mocking AWS SDK clients in unit tests. While it does not directly provide event stream serialization and deserialization, it can be used to mock the behavior of AWS services that use event streams, making it useful for testing purposes.

README

@aws-sdk/@aws-sdk/eventstream-serde-config-resolver

An internal package

Usage

You probably shouldn't, at least directly.

Changelog

1.0.0-rc.7 (2020-11-20)

Bug Fixes

• abort-controller: make AbortSignal WHATWG Spec compliant (#1699) (723ec4d)
• codegen: add aws-iam-traits dependency (#1686) (d6fb1f6)
• fetch-http-handler: omit body for HEAD/GET methods (#1698) (778b305)
• node-http-handler: throw TimeoutError for Node.js timeouts (#1693) (96f61bb)
• change paginators to export paginateOperationName (#1692) (6d02935)

Features

• update clients as of 11/18/2020 (#1700) (8adfed1)
• api-reference: add typedoc plugins for api reference (#1694) (2cb016f)
• ci: add GitHub Action to test codegen (#1684) (41e9359)
• node-http-handler: update timeout code and tests (#1691) (9e58bbb)
• service-error-classification: add 429 response as Throttling (#1690) (9a62c0a)

BREAKING CHANGES

• change paginators to export paginateOperationName to be consistent with verb nouns across AWS