decodeEventStreamMessage

Decode a framed event-stream message, validating both CRCs.

function decodeEventStreamMessage(data): EventStreamMessage;

Defined in: src/utils/aws/eventstream.ts:179

Decode a framed event-stream message, validating both CRCs.

Parameters

Parameter	Type	Description
`data`	`ArrayBuffer` \| `Uint8Array`<`ArrayBufferLike`>	The complete binary message (one WebSocket frame from AWS).

Returns

EventStreamMessage

The decoded headers and payload.

Throws

Error when the buffer is truncated, a length field is inconsistent, a CRC check fails, or a header value type is unknown.

Example

const message = decodeEventStreamMessage(event.data);
if (message.headers[':message-type'] === 'event') {
  const body = JSON.parse(new TextDecoder().decode(message.payload));
}