Skip to main content
Version: Current

NonRetryableError

@rotorsoft/act-root

@rotorsoft/act-root / act/src / NonRetryableError

Class: NonRetryableError

Defined in: libs/act/src/types/errors.ts:308

Thrown by a reaction handler to signal that the failure is permanent and the drain pipeline should block the stream immediately, without consuming the rest of the maxRetries budget.

The drain finalizer detects instanceof NonRetryableError and forces block = options.blockOnError regardless of lease.retry. When blockOnError is false, behavior is unchanged (drain keeps retrying forever) — the class never overrides the operator's explicit "never block" choice.

Use this for failures the handler knows won't get better on retry: a 4xx from a webhook, a ZodError on malformed input, a "user deleted" 404 from a downstream API. Use regular Error (or a subclass) for transient failures so the existing retry-with-backoff loop applies.

Example​

Wrapping a permanent downstream error

import { NonRetryableError } from "@rotorsoft/act";

.on("OrderConfirmed")
  .do(async function notifyPartner(event) {
    const res = await fetch(url, ...);
    if (res.status >= 400 && res.status < 500) {
      throw new NonRetryableError(
        `webhook ${url} responded ${res.status}`,
        { cause: await res.text() }
      );
    }
    if (!res.ok) throw new Error(`webhook ${url} responded ${res.status}`);
  })

Extends​

  • Error

Extended by​

Constructors​

Constructor​

new NonRetryableError(message, options?): NonRetryableError

Defined in: libs/act/src/types/errors.ts:312

Parameters​

message​

string

options?​
cause?​

unknown

Returns​

NonRetryableError

Overrides​

Error.constructor

Properties​

cause?​

readonly optional cause?: unknown

Defined in: libs/act/src/types/errors.ts:310

The original failure, if any. Mirrors the standard Error.cause shape.

Overrides​

Error.cause

message​

message: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from​

Error.message

name​

name: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from​

Error.name

stack?​

optional stack?: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

Error.stack

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@22.20.5/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/.pnpm/@types+node@22.20.5/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/.pnpm/@types+node@22.20.5/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