Skip to main content

Class: ActivityExecutionFailedError

client.ActivityExecutionFailedError

Thrown by the ActivityClient while waiting on Activity execution result if execution completes with failure. The failure is stored in the cause property.

Standalone Activities are experimental. APIs may be subject to change.

Hierarchy​

  • Error

    ↳ ActivityExecutionFailedError

Constructors​

constructor​

• new ActivityExecutionFailedError(message, cause, activityId, runId?): ActivityExecutionFailedError

Parameters​

NameType
messagestring
causeundefined | Error
activityIdstring
runId?string

Returns​

ActivityExecutionFailedError

Overrides​

Error.constructor

Properties​

activityId​

• Readonly activityId: string

cause​

• Readonly cause: undefined | Error

Overrides​

Error.cause

message​

• message: string

Inherited from​

Error.message

name​

• name: string

Inherited from​

Error.name

runId​

• Optional Readonly runId: string

stack​

• Optional stack: string

Inherited from​

Error.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​

Error.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​

NameType
targetObjectobject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

prepareStackTrace​

▸ prepareStackTrace(err, stackTraces): any

Parameters​

NameType
errError
stackTracesCallSite[]

Returns​

any

See

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

Inherited from​

Error.prepareStackTrace