Class Database

Hierarchy

Database

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Database(options: DatabaseOptions): Database

- Defined in database/index.ts:33
Parameters
- options: DatabaseOptions
Returns Database

Properties

logger

logger: LoggerInstance

mongoose

mongoose: mongoose.Mongoose

options

options: DatabaseOptions

Methods

connect

connect(): Promise<DatabaseOptions>

- Defined in database/index.ts:72
Connects to the remote database.

Returns Promise<DatabaseOptions>

disconnect

disconnect(): Promise<void>

- Defined in database/index.ts:92
Disconnects the database.

Returns Promise<void>

isReady

isReady(): boolean

- Defined in database/index.ts:101
Checks if the database is connected and ready for transactions.

Returns boolean

model

model<T>(name: string | T | any): BaseModel

- Defined in database/index.ts:50
Gets or registers a moongoose model instance by its name or definition.

Type parameters
- T: BaseModel
Parameters
- name: string | T | any
  
  The model name
Returns BaseModel

onError

onError(error: any): void

- Defined in database/index.ts:109
Handles database errors, can be extended to include process graceful shutdown.

Parameters
- error: any
Returns void

Generated using TypeDoc