Skip to main content

Class: ChildWorkflowFailure

common.ChildWorkflowFailure

Contains information about a Child Workflow failure. Always contains the reason for the failure as its cause. For example, if the Child was Terminated, the cause is a TerminatedFailure.

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

Hierarchy

Constructors

constructor

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

Parameters

NameType
namespaceundefined | string
executionIWorkflowExecution
workflowTypestring
retryStateRetryState
cause?Error

Returns

ChildWorkflowFailure

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

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

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

TemporalFailure.prepareStackTrace


stackTraceLimit

Static stackTraceLimit: number

Inherited from

TemporalFailure.stackTraceLimit

Methods

captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

TemporalFailure.captureStackTrace