Skip to main content

Class: DefaultFailureConverter

Default, cross-language-compatible Failure converter.

By default, it will leave error messages and stack traces as plain text. In order to encrypt them, set encodeCommonAttributes to true in the constructor options and use a PayloadCodec that can encrypt / decrypt Payloads in your WorkerOptions.dataConverter | Worker and ClientOptions.dataConverter | Client options.

Implements​

Constructors​

Constructor​

new DefaultFailureConverter(options?): DefaultFailureConverter

Parameters​

options?​

Partial<DefaultFailureConverterOptions>

Returns​

DefaultFailureConverter

Properties​

options​

readonly options: DefaultFailureConverterOptions

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

Implementation of​

FailureConverter.errorToFailure

errorToFailureInner()​

errorToFailureInner(err, payloadConverter, context?): IFailure

Parameters​

err​

unknown

payloadConverter​

PayloadConverter

context?​

SerializationContext

Returns​

IFailure

failureToError()​

failureToError(failure, payloadConverter, context?): Error

Converts a Failure proto message to a JS Error object.

The returned error must be an instance of TemporalFailure.

Parameters​

failure​

IFailure

payloadConverter​

PayloadConverter

context?​

SerializationContext

Returns​

Error

Implementation of​

FailureConverter.failureToError

failureToErrorInner()​

failureToErrorInner(failure, payloadConverter, context?): Error

Converts a Failure proto message to a JS Error object.

Does not set common properties, that is done in failureToError.

Parameters​

failure​

IFailure

payloadConverter​

PayloadConverter

context?​

SerializationContext

Returns​

Error

optionalErrorToOptionalFailure()​

optionalErrorToOptionalFailure(err, payloadConverter, context?): IFailure | undefined

Converts an error to a Failure proto message if defined or returns undefined

Parameters​

err​

unknown

payloadConverter​

PayloadConverter

context?​

SerializationContext

Returns​

IFailure | undefined

optionalFailureToOptionalError()​

optionalFailureToOptionalError(failure, payloadConverter, context?): Error | undefined

Converts a Failure proto message to a JS Error object if defined or returns undefined.

Parameters​

failure​

IFailure | null | undefined

payloadConverter​

PayloadConverter

context?​

SerializationContext

Returns​

Error | undefined