Metzploreur/node_modules/@smithy/eventstream-codec/dist-types/EventStreamCodec.d.ts
clement callaert 244d45ceb8 Version 2
2023-11-01 17:33:25 +01:00

31 lines
1.2 KiB
TypeScript

import { AvailableMessage, AvailableMessages, Message, MessageDecoder, MessageEncoder, MessageHeaders } from "@smithy/types";
import { Decoder, Encoder } from "@smithy/types";
/**
* A Codec that can convert binary-packed event stream messages into
* JavaScript objects and back again into their binary format.
*/
export declare class EventStreamCodec implements MessageEncoder, MessageDecoder {
private readonly headerMarshaller;
private messageBuffer;
private isEndOfStream;
constructor(toUtf8: Encoder, fromUtf8: Decoder);
feed(message: ArrayBufferView): void;
endOfStream(): void;
getMessage(): AvailableMessage;
getAvailableMessages(): AvailableMessages;
/**
* Convert a structured JavaScript object with tagged headers into a binary
* event stream message.
*/
encode({ headers: rawHeaders, body }: Message): Uint8Array;
/**
* Convert a binary event stream message into a JavaScript object with an
* opaque, binary body and tagged, parsed headers.
*/
decode(message: ArrayBufferView): Message;
/**
* Convert a structured JavaScript object with tagged headers into a binary
* event stream message header.
*/
formatHeaders(rawHeaders: MessageHeaders): Uint8Array;
}