Class: ActivityFailure

common.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 will be a TimeoutFailure.

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

Hierarchy

• TemporalFailure

  ↳ ActivityFailure

Constructors

constructor

• new ActivityFailure(message, activityType, activityId, retryState, identity, cause?): ActivityFailure

Parameters

Name	Type
message	undefined | string
activityType	string
activityId	undefined | string
retryState	RetryState
identity	undefined | string
cause?	Error

Returns

ActivityFailure

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

• name: string

Inherited from

TemporalFailure.name

---

retryState

• Readonly retryState: RetryState

---

stack

• Optional stack: string

Inherited from

TemporalFailure.stack

---

stackTraceLimit

▪ Static stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

TemporalFailure.stackTraceLimit

Methods

captureStackTrace

▸ captureStackTrace(targetObject, constructorOpt?): void

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

TemporalFailure.captureStackTrace

---

prepareStackTrace

▸ prepareStackTrace(err, stackTraces): any

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

TemporalFailure.prepareStackTrace