Class ConnectionError

Error for database connection issues

Hierarchy (View Summary)

PrormError
- ConnectionError

Index

Constructors

Properties

code parent? sql? metadata? database? host?

Methods

toJSON refused timedOut unreachable invalid

Constructors

constructor

new ConnectionError(
    message?: string,
    options?: {
        code?: ErrorCode;
        parent?: Error;
        database?: string;
        host?: string;
        sql?: string;
    },
): ConnectionError
Parameters
- message: string = 'Unable to connect to database'
- options: {
      code?: ErrorCode;
      parent?: Error;
      database?: string;
      host?: string;
      sql?: string;
  } = {}
Returns ConnectionError
Overrides PrormError.constructor
- Defined in errors/index.ts:106

Properties

`Readonly`code

code: ErrorCode

Unique error code for programmatic handling

`Optional` `Readonly`parent

parent?: Error

Original error that caused this error

`Optional` `Readonly`sql

sql?: string

SQL query that caused the error

`Optional` `Readonly`metadata

metadata?: Record<string, unknown>

Additional error properties

`Optional` `Readonly`database

database?: string

The database that was being connected to

`Optional` `Readonly`host

host?: string

The host that was being connected to

Methods

toJSON

toJSON(): Record<string, unknown>
Convert to JSON for serialization

Returns Record<string, unknown>
Inherited from PrormError.toJSON
- Defined in errors/index.ts:84

`Static`refused

refused(
options?: { parent?: Error; database?: string; host?: string },
): ConnectionError
Create a connection refused error
Parameters
- options: { parent?: Error; database?: string; host?: string } = {}
Returns ConnectionError
- Defined in errors/index.ts:138

`Static`timedOut

timedOut(
options?: { parent?: Error; database?: string; host?: string },
): ConnectionError
Create a connection timeout error
Parameters
- options: { parent?: Error; database?: string; host?: string } = {}
Returns ConnectionError
- Defined in errors/index.ts:150

`Static`unreachable

unreachable(
options?: { parent?: Error; database?: string; host?: string },
): ConnectionError
Create a host unreachable error
Parameters
- options: { parent?: Error; database?: string; host?: string } = {}
Returns ConnectionError
- Defined in errors/index.ts:162

`Static`invalid

invalid(
options?: { parent?: Error; database?: string; host?: string },
): ConnectionError
Create an invalid connection error
Parameters
- options: { parent?: Error; database?: string; host?: string } = {}
Returns ConnectionError
- Defined in errors/index.ts:174