Class Database

Index

Constructors

Methods

delete destroy get getAll getAllOf open set use wipe

Constructors

constructor

new Database(): Database

Returns Database

Methods

`Static`delete

delete(kind: TimerKind, name: string): Promise<IDeleteResult>
Deletes an existing timer from the database.
Parameters
- kind: TimerKind
  The kind of the timer to delete.
- name: string
  The name of the timer to delete.
Returns Promise<IDeleteResult>
- Defined in src/structures/Database.ts:85

`Static`destroy

destroy(): Promise<void>
Closes the storage.

Returns Promise<void>
- Defined in src/structures/Database.ts:43

`Static`get

get(kind: TimerKind, name: string): Promise<Timer | null>
Gets an existing timer.
Parameters
- kind: TimerKind
  The kind of the timer to get.
- name: string
  The name of the timer to get.
Returns Promise<Timer | null>
- Defined in src/structures/Database.ts:53

`Static`getAll

getAll(): Promise<Timer[]>
Gets all existing timers.

Returns Promise<Timer[]>
- Defined in src/structures/Database.ts:60

`Static`getAllOf

getAllOf(kind: TimerKind): Promise<Timer[]>
Gets all existing timers of a kind.
Parameters
- kind: TimerKind
  The kind of the timers to get.
Returns Promise<Timer[]>
- Defined in src/structures/Database.ts:68

`Static`open

open(storage?: TimerStorage): Promise<ITimerStore>
Opens a storage without putting it in charge.
Parameters
- storage: TimerStorage = "forgedb"
  Which backend to open.
Returns Promise<ITimerStore>
- Defined in src/structures/Database.ts:14

`Static`set

set(timer: Timer): Promise<void>
Saves a timer in the database.
Parameters
- timer: Timer
  The timer to save.
Returns Promise<void>
- Defined in src/structures/Database.ts:76

`Static`use

use(storage?: TimerStorage): Promise<ITimerStore>
Opens the chosen storage and makes it the one everything reads. Replaces whatever was open before.
Parameters
- storage: TimerStorage = "forgedb"
  Which backend to keep timers in.
Returns Promise<ITimerStore>
- Defined in src/structures/Database.ts:25

`Static`wipe

wipe(): Promise<void>
Wipes every stored timer.

Returns Promise<void>
- Defined in src/structures/Database.ts:92