Skip to main content

Class: ActivityFailure

client.ActivityFailure

Contains information about an activity failure. Always contains the original reason for the failure as its cause. For example if an activity timed out the cause is TimeoutFailure.

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

Hierarchy#

Constructors#

constructor#

new ActivityFailure(activityType, activityId, retryState, identity, cause?)

Parameters#

NameType
activityTypestring
activityIdundefined | string
retryStateRetryState
identityundefined | string
cause?Error

Overrides#

TemporalFailure.constructor

Properties#

activityId#

Readonly activityId: undefined | string


activityType#

Readonly activityType: string


cause#

Optional Readonly cause: Error

Inherited from#

TemporalFailure.cause


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


identity#

Readonly identity: undefined | string


message#

message: string

Inherited from#

TemporalFailure.message


name#

Readonly name: string

Inherited from#

TemporalFailure.name


retryState#

Readonly retryState: RetryState


stack#

Optional stack: string

Inherited from#

TemporalFailure.stack


prepareStackTrace#

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

Optional override for formatting stack traces

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