Class: FirebirdBatchError

Defined in: packages/core/src/api/batch.ts:80

A batch row was rejected by the server (default, non-continueOnError mode).

Extends

• FirebirdError

Constructors

Constructor

new FirebirdBatchError(
   message, 
   index, 
   result, 
   cause?): FirebirdBatchError;

Defined in: packages/core/src/api/batch.ts:83

Parameters

Parameter	Type	Description
message	string	-
index	number	0-based index of the first failed row.
result	BatchResult	Completion state up to the failure (nothing is committed by own-tx wrappers).
cause?	FirebirdError	-

Returns

FirebirdBatchError

Overrides

FirebirdError.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
cause?	public	unknown	undefined	-	-	FirebirdError.cause	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
gdsCode?	readonly	number	undefined	Primary isc_* / gds error code (first arg_gds in the vector), if any.	-	FirebirdError.gdsCode	packages/core/src/api/errors.ts:13
index	readonly	number	undefined	0-based index of the first failed row.	-	-	packages/core/src/api/batch.ts:86
message	public	string	undefined	-	-	FirebirdError.message	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	'FirebirdBatchError'	-	FirebirdError.name	-	packages/core/src/api/batch.ts:81
result	readonly	BatchResult	undefined	Completion state up to the failure (nothing is committed by own-tx wrappers).	-	-	packages/core/src/api/batch.ts:88
sqlState?	readonly	string	undefined	SQLSTATE (arg_sql_state) when the server provided one.	-	FirebirdError.sqlState	packages/core/src/api/errors.ts:15
stack?	public	string	undefined	-	-	FirebirdError.stack	node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
statusVector	readonly	StatusVectorArg[]	[]	Full decoded status vector for advanced consumers.	-	FirebirdError.statusVector	packages/core/src/api/errors.ts:17
stackTraceLimit	static	number	undefined	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.	-	FirebirdError.stackTraceLimit	node_modules/.pnpm/@types+node@22.20.1/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

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.

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

FirebirdError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

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

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

FirebirdError.prepareStackTrace