Class default

Adds Firebase's Firestore cloud database as a persistence provider for the bot. Does nothing except provide a read/write interface for the database.

Hierarchy

Plugin<Config>
- default

Implements

PersistenceProvider

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new default(context: DiscordBot, _config?: Config): default

Overrides Plugin.constructor
- Defined in src/plugins/firebasePersist.ts:21
Parameters
- context: DiscordBot
- Optional _config: Config
Returns default

Properties

Protected config

config: Config

Protected context

context: DiscordBot

Private db

db: Firestore

Static defaultConfig

defaultConfig: Config = ...

Methods

clearHandlers

clearHandlers(): void

Inherited from Plugin.clearHandlers
- Defined in src/typedef/Plugin.ts:39
Returns void

declareHandler

declareHandler(name: string, handler: (event: CommunicationEvent) => void): void

Inherited from Plugin.declareHandler
- Defined in src/typedef/Plugin.ts:32
Parameters
- name: string
- handler: (event: CommunicationEvent) => void
  - - (event: CommunicationEvent): void
    - Parameters
      - event: CommunicationEvent
      Returns void
Returns void

extract

extract(): void

Overrides Plugin.extract
- Defined in src/plugins/firebasePersist.ts:38
Returns void

inject

inject(): void

Overrides Plugin.inject
- Defined in src/plugins/firebasePersist.ts:29
Returns void

readUser

readUser<T>(userID: string, query: T): Promise<T>

Implementation of PersistenceProvider.readUser
- Defined in src/plugins/firebasePersist.ts:42
Type parameters
- T
Parameters
- userID: string
- query: T
Returns Promise<T>

writeUser

writeUser(userID: string, data: object): Promise<Date>

Implementation of PersistenceProvider.writeUser
- Defined in src/plugins/firebasePersist.ts:52
Parameters
- userID: string
- data: object
Returns Promise<Date>

Generated using TypeDoc