DeathPactError

Defined in: src/Supervision.ts:173

Death-pact failure: a watcher decides it cannot carry on without the actor whose Terminated it just received.

The runtime never raises this. It is exported for an application to throw deliberately from its own Terminated handler, from where it travels through supervision like any other failure — so pair it with a decider that stops or escalates, or the default strategy will simply restart the watcher.

Ignoring a Terminated is not a failure here, and that is deliberate rather than an oversight: Actor.onReceive returns void, so the cell that dispatched the signal has no return channel telling it whether the handler acted on it. There is nothing to hang an automatic pact on until a dedicated termination hook exists (see #662), and adding one would turn today’s no-op into a supervision fault for every actor that watches and ignores.

Extends

• Error

Constructors

Constructor

new DeathPactError(actorPath): DeathPactError

Defined in: src/Supervision.ts:174

Parameters

actorPath

string

Returns

DeathPactError

Overrides

Error.constructor

Properties

actorPath

readonly actorPath: string

Defined in: src/Supervision.ts:174

---

cause?

optional cause?: unknown

Defined in: docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

---

message

message: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

---

name

name: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

---

stack?

optional stack?: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

---

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:68

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()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:52

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

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace