Class: StrandsFailureConverter
strands.StrandsFailureConverter
Failure converter that preserves Strands InterruptError payloads across the
activity boundary as typed, non-retryable ApplicationFailures and
marks deterministic Strands model errors as non-retryable.
Read by the worker and client via DataConverter.failureConverterPath; the named export below is what StrandsPlugin wires in.
Hierarchy
-
↳
StrandsFailureConverter
Implements
Constructors
constructor
• new StrandsFailureConverter(options?): StrandsFailureConverter
Parameters
| Name | Type |
|---|---|
options? | Partial<DefaultFailureConverterOptions> |
Returns
Inherited from
DefaultFailureConverter.constructor
Properties
options
• Readonly options: DefaultFailureConverterOptions
Inherited from
DefaultFailureConverter.options
Methods
errorToFailure
▸ errorToFailure(err, payloadConverter, context?): IFailure
Converts a caught error to a Failure proto message.
Parameters
| Name | Type |
|---|---|
err | unknown |
payloadConverter | PayloadConverter |
context? | SerializationContext |
Returns
Implementation of
FailureConverter.errorToFailure
Overrides
DefaultFailureConverter.errorToFailure
errorToFailureInner
▸ errorToFailureInner(err, payloadConverter, context?): IFailure
Parameters
| Name | Type |
|---|---|
err | unknown |
payloadConverter | PayloadConverter |
context? | SerializationContext |
Returns
Inherited from
DefaultFailureConverter.errorToFailureInner
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
| Name | Type |
|---|---|
failure | IFailure |
payloadConverter | PayloadConverter |
context? | SerializationContext |
Returns
Error
Implementation of
FailureConverter.failureToError
Inherited from
DefaultFailureConverter.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
| Name | Type |
|---|---|
failure | IFailure |
payloadConverter | PayloadConverter |
context? | SerializationContext |
Returns
Error
Inherited from
DefaultFailureConverter.failureToErrorInner
optionalErrorToOptionalFailure
▸ optionalErrorToOptionalFailure(err, payloadConverter, context?): undefined | IFailure
Converts an error to a Failure proto message if defined or returns undefined
Parameters
| Name | Type |
|---|---|
err | unknown |
payloadConverter | PayloadConverter |
context? | SerializationContext |
Returns
undefined | IFailure
Inherited from
DefaultFailureConverter.optionalErrorToOptionalFailure
optionalFailureToOptionalError
▸ optionalFailureToOptionalError(failure, payloadConverter, context?): undefined | Error
Converts a Failure proto message to a JS Error object if defined or returns undefined.
Parameters
| Name | Type |
|---|---|
failure | undefined | null | IFailure |
payloadConverter | PayloadConverter |
context? | SerializationContext |
Returns
undefined | Error