Skip to main content
Version: 0.17.x

Class: ConnectionError

Defined in: src/errors/index.ts:109

Error for database connection issues

Extends​

Constructors​

Constructor​

new ConnectionError(message, host?, port?, originalError?): ConnectionError

Defined in: src/errors/index.ts:113

Parameters​

message​

string

host?​

string

port?​

number

originalError?​

Error

Returns​

ConnectionError

Overrides​

FreshGuardError.constructor

Properties​

cause?​

optional cause: unknown

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

Inherited from​

FreshGuardError.cause

code​

readonly code: string

Defined in: src/errors/index.ts:18

Inherited from​

FreshGuardError.code

debug?​

optional debug: DebugInfo

Defined in: src/errors/index.ts:22

Inherited from​

FreshGuardError.debug

debugId​

readonly debugId: string

Defined in: src/errors/index.ts:21

Inherited from​

FreshGuardError.debugId

host?​

readonly optional host: string

Defined in: src/errors/index.ts:110

message​

message: string

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

Inherited from​

FreshGuardError.message

name​

name: string

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

Inherited from​

FreshGuardError.name

port?​

readonly optional port: number

Defined in: src/errors/index.ts:111

sanitized​

readonly sanitized: boolean

Defined in: src/errors/index.ts:20

Inherited from​

FreshGuardError.sanitized

stack?​

optional stack: string

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

Inherited from​

FreshGuardError.stack

timestamp​

readonly timestamp: Date

Defined in: src/errors/index.ts:19

Inherited from​

FreshGuardError.timestamp

stackTraceLimit​

static stackTraceLimit: number

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

FreshGuardError.stackTraceLimit

Methods​

toJSON()​

toJSON(): object

Defined in: src/errors/index.ts:42

Convert error to JSON for logging

Returns​

object

Inherited from​

FreshGuardError.toJSON

authenticationFailed()​

static authenticationFailed(host): ConnectionError

Defined in: src/errors/index.ts:170

Parameters​

host​

string

Returns​

ConnectionError

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

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

FreshGuardError.captureStackTrace

databaseNotFound()​

static databaseNotFound(_database, host): ConnectionError

Defined in: src/errors/index.ts:177

Parameters​

_database​

string

host​

string

Returns​

ConnectionError

hostUnreachable()​

static hostUnreachable(host, port?): ConnectionError

Defined in: src/errors/index.ts:162

Parameters​

host​

string

port?​

number

Returns​

ConnectionError

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

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

FreshGuardError.prepareStackTrace