Skip to main content
Version: Current

StoreError

@rotorsoft/act-root


@rotorsoft/act-root / act/src / StoreError

Class: StoreError

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

Thrown by a Store adapter when an infrastructure operation fails for a reason that is not a domain condition โ€” a dropped connection, a transaction rollback, a query timeout. It is the typed boundary between "the store is unavailable/degraded" and the domain errors above (ConcurrencyError, StreamClosedError), which describe legitimate outcomes the caller should branch on.

Adapters wrap their driver errors in StoreError (preserving the original via cause) so the orchestrator can distinguish a degraded backend from "no work" and react accordingly โ€” see the drain circuit breaker, which trips on repeated StoreErrors and surfaces an error lifecycle event instead of silently spinning on a down database.

Exampleโ€‹

app.on("error", ({ error, circuit }) => {
if (error instanceof StoreError)
alert(`store ${error.operation} failing; circuit=${circuit}`);
});

Extendsโ€‹

  • Error

Constructorsโ€‹

Constructorโ€‹

new StoreError(operation, options?): StoreError

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

Parametersโ€‹

operationโ€‹

string

options?โ€‹
cause?โ€‹

unknown

Returnsโ€‹

StoreError

Overridesโ€‹

Error.constructor

Propertiesโ€‹

cause?โ€‹

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited fromโ€‹

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


operationโ€‹

readonly operation: string

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

The store operation that failed (e.g. "claim", "ack", "commit").


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@25.9.4/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โ€‹

Error.stackTraceLimit

Methodsโ€‹

captureStackTrace()โ€‹

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.9.4/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โ€‹

Error.captureStackTrace


prepareStackTrace()โ€‹

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.9.4/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โ€‹

Error.prepareStackTrace