Interface: PayloadConverter
Used by the framework to serialize/deserialize data like parameters and return values.
This is called inside the Workflow isolate. To write async code or use Node APIs (or use packages that use Node APIs), use a PayloadCodec.
Properties
validateConverterHint?
optionalvalidateConverterHint?: (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
Returns
boolean
Methods
fromPayload()
fromPayload<
T>(payload,context?,hint?):T
Converts a Payload back to a value.
Type Parameters
T
T
Parameters
payload
context?
hint?
Returns
T
toPayload()
toPayload<
T>(value,context?,hint?):IPayload
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?
hint?
Returns
The Payload.
Should throw ValueError if unable to convert.