Class Database<T>`Abstract`

Type Parameters

T

A certain database type definition.

Hierarchy

Database
- FirestoreDatabase

Index

Constructors

Properties

Methods

getDB initDB isProdDB

Constructors

constructor

new Database<T>(): Database<T>
Type Parameters
- T
Returns Database<T>
- Defined in util/database/Database.ts:15

Properties

`Private` `Readonly` db

db: T

`Protected` debug

debug: Debugger = ...

Methods

getDB

getDB(): T
The getDB() method returns database instance and prevents user from accidentally access the production database.

Returns T
- Defined in util/database/Database.ts:37

`Protected` `Abstract` initDB

initDB(): T
Protected
The initDB() abstract method will be called in the class constructor to initialise the database. This returns the database specified by generic T.

Abstract

Returns T
- Defined in util/database/Database.ts:26

`Protected` `Abstract` isProdDB

isProdDB(): boolean
Protected
The isProdDB() abstract method checks the connection whether it is a production or not.

Returns boolean
- Defined in util/database/Database.ts:32

Generated using TypeDoc