@smithy/eventstream-serde-universal

Serialization

This feature allows you to serialize an event into a format suitable for transmission over a network. The code sample demonstrates how to create an instance of EventStreamMarshaller and use it to serialize an event object.

const { EventStreamMarshaller } = require('@smithy/eventstream-serde-universal');
const marshaller = new EventStreamMarshaller();
const event = { type: 'event', data: 'example data' };
const serializedEvent = marshaller.serialize(event);
console.log(serializedEvent);

Deserialization

This feature allows you to deserialize a received event stream back into a usable event object. The code sample shows how to create an instance of EventStreamMarshaller and use it to deserialize a binary event stream.

const { EventStreamMarshaller } = require('@smithy/eventstream-serde-universal');
const marshaller = new EventStreamMarshaller();
const serializedEvent = new Uint8Array([/* some binary data */]);
const event = marshaller.deserialize(serializedEvent);
console.log(event);

Event Stream Handling

This feature demonstrates handling a stream of events by serializing and then deserializing them. The code sample shows how to process an array of event objects, serialize them, and then deserialize them back to their original form.

const { EventStreamMarshaller } = require('@smithy/eventstream-serde-universal');
const marshaller = new EventStreamMarshaller();
const eventStream = [
  { type: 'event', data: 'data1' },
  { type: 'event', data: 'data2' }
];
const serializedStream = eventStream.map(event => marshaller.serialize(event));
const deserializedStream = serializedStream.map(event => marshaller.deserialize(event));
console.log(deserializedStream);