Skip to main content

Class: ChildWorkflowFailure

common.ChildWorkflowFailure

Contains information about an child workflow failure. Always contains the original reason for the failure as its cause. For example if a child workflow was terminated the cause is TerminatedFailure.

This exception is expected to be thrown only by the framework code.

Hierarchy#

Constructors#

constructor#

new ChildWorkflowFailure(namespace, execution, workflowType, retryState, cause?)

Parameters#

NameType
namespaceundefined | string
executionIWorkflowExecution
workflowTypestring
retryStateRetryState
cause?Error

Overrides#

TemporalFailure.constructor

Properties#

cause#

Optional Readonly cause: Error

Inherited from#

TemporalFailure.cause


execution#

Readonly execution: IWorkflowExecution


failure#

Optional failure: IFailure

The original failure that constructed this error.

Only present if this error was generated from an external operation.

Inherited from#

TemporalFailure.failure


message#

message: string

Inherited from#

TemporalFailure.message


name#

Readonly name: string

Inherited from#

TemporalFailure.name


namespace#

Readonly namespace: undefined | string


retryState#

Readonly retryState: RetryState


stack#

Optional stack: string

Inherited from#

TemporalFailure.stack


workflowType#

Readonly workflowType: string


prepareStackTrace#

Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration#

▸ (err, stackTraces): any

Optional override for formatting stack traces

Parameters#
NameType
errError
stackTracesCallSite[]
Returns#

any

Inherited from#

TemporalFailure.prepareStackTrace


stackTraceLimit#

Static stackTraceLimit: number

Inherited from#

TemporalFailure.stackTraceLimit

Methods#

captureStackTrace#

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters#

NameType
targetObjectobject
constructorOpt?Function

Returns#

void

Inherited from#

TemporalFailure.captureStackTrace