Class FirestoreDatabase

Hierarchy

Database<Firestore>
- FirestoreDatabase

Index

Constructors

Properties

debug projectID

Methods

getDB initDB isProdDB

Constructors

constructor

new FirestoreDatabase(): FirestoreDatabase
Returns FirestoreDatabase
Inherited from Database.constructor
- Defined in util/database/Database.ts:15

Properties

`Protected` debug

debug: Debugger = ...

`Private` projectID

projectID: undefined | string = process.env.FCERT_PROJECT_ID

Methods

getDB

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

Returns Firestore
Inherited from Database.getDB
- Defined in util/database/Database.ts:37

`Protected` initDB

initDB(): Firestore
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 Firestore
Overrides Database.initDB
- Defined in builtin/data/FirestoreDatabase.ts:12

`Protected` isProdDB

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

Returns boolean
Overrides Database.isProdDB
- Defined in builtin/data/FirestoreDatabase.ts:28

Generated using TypeDoc