Skip to main content

Class: CompositePayloadConverter

Tries to convert values to Payloads using the PayloadConverterWithEncodings provided to the constructor, in the order provided.

Converts Payloads to values based on the Payload.metadata.encoding field, which matches the PayloadConverterWithEncoding.encodingType of the converter that created the Payload.

Extended by​

Implements​

Constructors​

Constructor​

new CompositePayloadConverter(...converters): CompositePayloadConverter

Parameters​

converters​

...PayloadConverterWithEncoding[]

Returns​

CompositePayloadConverter

Properties​

converterByEncoding​

readonly converterByEncoding: Map<string, PayloadConverterWithEncoding>

converters​

readonly converters: PayloadConverterWithEncoding[]

Methods​

fromPayload()​

fromPayload<T>(payload, context?, hint?): T

Run PayloadConverterWithEncoding.fromPayload based on the encoding metadata of the Payload.

Type Parameters​

T​

T

Parameters​

payload​

IPayload

context?​

SerializationContext

hint?​

ConverterHint<T>

Returns​

T

Implementation of​

PayloadConverter.fromPayload

toPayload()​

toPayload<T>(value, context?, hint?): IPayload

Tries to run .toPayload(value) on each converter in the order provided at construction. Returns the first successful result, throws ValueError if there is no converter that can handle the value.

Type Parameters​

T​

T

Parameters​

value​

T

context?​

SerializationContext

hint?​

ConverterHint<T>

Returns​

IPayload

Implementation of​

PayloadConverter.toPayload