Skip to main content

Interface: FailureConverter

A FailureConverter is responsible for converting from proto Failure instances to JS Errors and back.

We recommended using the DefaultFailureConverter instead of customizing the default implementation in order to maintain cross-language Failure serialization compatibility.

Methods​

errorToFailure()​

errorToFailure(err, payloadConverter, context?): IFailure

Converts a caught error to a Failure proto message.

Parameters​

err​

unknown

payloadConverter​

PayloadConverter

context?​

SerializationContext

Returns​

IFailure


failureToError()​

failureToError(err, payloadConverter, context?): Error

Converts a Failure proto message to a JS Error object.

The returned error must be an instance of TemporalFailure.

Parameters​

err​

IFailure

payloadConverter​

PayloadConverter

context?​

SerializationContext

Returns​

Error