ElectricDBCollectionError

Class: ElectricDBCollectionError

Defined in: packages/electric-db-collection/src/errors.ts:4

Extends

  • TanStackDBError

Extended by

Constructors

Constructor

ts
new ElectricDBCollectionError(message, collectionId?): ElectricDBCollectionError;
new ElectricDBCollectionError(message, collectionId?): ElectricDBCollectionError;

Defined in: packages/electric-db-collection/src/errors.ts:5

Parameters

message

string

collectionId?

string

Returns

ElectricDBCollectionError

Overrides

ts
TanStackDBError.constructor
TanStackDBError.constructor

Properties

cause?

ts
optional cause: unknown;
optional cause: unknown;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

ts
TanStackDBError.cause
TanStackDBError.cause

message

ts
message: string;
message: string;

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

Inherited from

ts
TanStackDBError.message
TanStackDBError.message

name

ts
name: string;
name: string;

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

Inherited from

ts
TanStackDBError.name
TanStackDBError.name

stack?

ts
optional stack: string;
optional stack: string;

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

Inherited from

ts
TanStackDBError.stack
TanStackDBError.stack

stackTraceLimit

ts
static stackTraceLimit: number;
static stackTraceLimit: number;

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

ts
TanStackDBError.stackTraceLimit
TanStackDBError.stackTraceLimit

Methods

captureStackTrace()

ts
static captureStackTrace(targetObject, constructorOpt?): void;
static captureStackTrace(targetObject, constructorOpt?): void;

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

js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
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:

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

ts
TanStackDBError.captureStackTrace
TanStackDBError.captureStackTrace

prepareStackTrace()

ts
static prepareStackTrace(err, stackTraces): any;
static prepareStackTrace(err, stackTraces): any;

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

ts
TanStackDBError.prepareStackTrace
TanStackDBError.prepareStackTrace
Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.