Skip to main content

Interface: PayloadConverterWithEncoding

common.PayloadConverterWithEncoding

Implemented by

Properties

encodingType

Readonly encodingType: string

Methods

fromPayload

fromPayload<T>(payload): T

Converts a Payload back to a value.

Type parameters

Name
T

Parameters

NameType
payloadIPayload

Returns

T


toPayload

toPayload<T>(value): undefined | IPayload

Converts a value to a Payload.

Type parameters

Name
T

Parameters

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

Returns

undefined | IPayload

The Payload, or undefined if unable to convert.