Skip to main content

Interface: PayloadConverterWithEncoding

Properties​

encodingType​

readonly encodingType: string

validateConverterHint?​

optional validateConverterHint?: (hint) => boolean

Experimental

Return whether this converter can handle the supplied converter hint.

Implementations may also use this method to validate hints within toPayload and fromPayload.

Parameters​

hint​

ConverterHint

Returns​

boolean

Methods​

fromPayload()​

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

Converts a Payload back to a value.

Type Parameters​

T​

T

Parameters​

payload​

IPayload

context?​

SerializationContext

hint?​

ConverterHint<T>

Returns​

T

toPayload()​

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

Converts a value to a Payload.

Type Parameters​

T​

T

Parameters​

value​

T

The value to convert. Example values include the Workflow args sent from the Client and the values returned by a Workflow or Activity.

context?​

SerializationContext

hint?​

ConverterHint<T>

Returns​

IPayload | undefined

The Payload, or undefined if unable to convert.