Skip to content

Class: FirebirdConnectionError ​

Defined in: packages/core/src/api/errors.ts:23

Extends ​

Constructors ​

Constructor ​

ts
new FirebirdConnectionError(
   message, 
   gdsCode?, 
   sqlState?, 
   statusVector?): FirebirdConnectionError;

Defined in: packages/core/src/api/errors.ts:10

Parameters ​

ParameterTypeDefault valueDescription
messagestringundefined-
gdsCode?numberundefinedPrimary isc_* / gds error code (first arg_gds in the vector), if any.
sqlState?stringundefinedSQLSTATE (arg_sql_state) when the server provided one.
statusVector?StatusVectorArg[][]Full decoded status vector for advanced consumers.

Returns ​

FirebirdConnectionError

Inherited from ​

FirebirdError.constructor

Properties ​

PropertyModifierTypeDefault valueDescriptionOverridesInherited fromDefined in
cause?publicunknownundefined--FirebirdError.causenode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
gdsCode?readonlynumberundefinedPrimary isc_* / gds error code (first arg_gds in the vector), if any.-FirebirdError.gdsCodepackages/core/src/api/errors.ts:13
messagepublicstringundefined--FirebirdError.messagenode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
namepublicstring'FirebirdConnectionError'-FirebirdError.name-packages/core/src/api/errors.ts:24
sqlState?readonlystringundefinedSQLSTATE (arg_sql_state) when the server provided one.-FirebirdError.sqlStatepackages/core/src/api/errors.ts:15
stack?publicstringundefined--FirebirdError.stacknode_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
statusVectorreadonlyStatusVectorArg[][]Full decoded status vector for advanced consumers.-FirebirdError.statusVectorpackages/core/src/api/errors.ts:17
stackTraceLimitstaticnumberundefinedThe 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.-FirebirdError.stackTraceLimitnode_modules/.pnpm/@types+node@22.20.1/node_modules/@types/node/globals.d.ts:68

Methods ​

captureStackTrace() ​

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

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

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

Parameters ​

ParameterType
targetObjectobject
constructorOpt?Function

Returns ​

void

Inherited from ​

FirebirdError.captureStackTrace


prepareStackTrace() ​

ts
static prepareStackTrace(err, stackTraces): any;

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

Parameters ​

ParameterType
errError
stackTracesCallSite[]

Returns ​

any

See ​

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

Inherited from ​

FirebirdError.prepareStackTrace

MIT Licensed. Contains data derived from the Firebird project under IDPL/IPL.