Skip to main content

Class: DefaultPayloadConverter

common.DefaultPayloadConverter

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 encodingType of the converter that created the Payload.

Hierarchy

Constructors

constructor

new DefaultPayloadConverter()

Overrides

CompositePayloadConverter.constructor

Properties

converterByEncoding

Readonly converterByEncoding: Map<string, PayloadConverterWithEncoding>

Inherited from

CompositePayloadConverter.converterByEncoding


converters

Readonly converters: PayloadConverterWithEncoding[]

Inherited from

CompositePayloadConverter.converters

Methods

fromPayload

fromPayload<T>(payload): T

Run fromPayload based on the encoding metadata of the Payload.

Type parameters

Name
T

Parameters

NameType
payloadIPayload

Returns

T

Inherited from

CompositePayloadConverter.fromPayload


toPayload

toPayload<T>(value): 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

Name
T

Parameters

NameType
valueT

Returns

IPayload

Inherited from

CompositePayloadConverter.toPayload