Skip to main content

NonRetryableWebhookError

@rotorsoft/act-root


@rotorsoft/act-root / act-http/src/webhook / NonRetryableWebhookError

Class: NonRetryableWebhookError

Defined in: libs/act-http/src/webhook/types.ts:118

Thrown when a webhook returns a 4xx response. Extends NonRetryableError so the drain finalizer blocks the stream on the first failed attempt (when blockOnError is true) โ€” no wasted retries on permanent client errors.

Carries the same status / url / responseBody fields as WebhookError; not a subclass of it (a single instance can't be both WebhookError and NonRetryableError). Callers catching either retryable or non-retryable webhook failures should check both classes, or check the shared fields directly.

Extendsโ€‹

Constructorsโ€‹

Constructorโ€‹

new NonRetryableWebhookError(message, init): NonRetryableWebhookError

Defined in: libs/act-http/src/webhook/types.ts:123

Parametersโ€‹

messageโ€‹

string

initโ€‹

WebhookErrorInit

Returnsโ€‹

NonRetryableWebhookError

Overridesโ€‹

NonRetryableError.constructor

Propertiesโ€‹

cause?โ€‹

readonly optional cause?: unknown

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

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

Inherited fromโ€‹

NonRetryableError.cause


messageโ€‹

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited fromโ€‹

NonRetryableError.message


nameโ€‹

name: string

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

Inherited fromโ€‹

NonRetryableError.name


responseBody?โ€‹

readonly optional responseBody?: string

Defined in: libs/act-http/src/webhook/types.ts:121


stack?โ€‹

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited fromโ€‹

NonRetryableError.stack


statusโ€‹

readonly status: number

Defined in: libs/act-http/src/webhook/types.ts:119


urlโ€‹

readonly url: string

Defined in: libs/act-http/src/webhook/types.ts:120


stackTraceLimitโ€‹

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.8.0/node_modules/@types/node/globals.d.ts:67

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โ€‹

NonRetryableError.stackTraceLimit

Methodsโ€‹

captureStackTrace()โ€‹

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.8.0/node_modules/@types/node/globals.d.ts:51

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โ€‹

NonRetryableError.captureStackTrace


prepareStackTrace()โ€‹

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.8.0/node_modules/@types/node/globals.d.ts:55

Parametersโ€‹

errโ€‹

Error

stackTracesโ€‹

CallSite[]

Returnsโ€‹

any

Seeโ€‹

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

Inherited fromโ€‹

NonRetryableError.prepareStackTrace