Interface ITimerStore

Everything ForgeTimers needs from a database. One implementation per backend, picked by the storage option.

interface ITimerStore {
    delete(kind: TimerKind, name: string): Promise<IDeleteResult>;
    destroy(): Promise<void>;
    get(kind: TimerKind, name: string): Promise<Timer | null>;
    getAll(): Promise<Timer[]>;
    getAllOf(kind: TimerKind): Promise<Timer[]>;
    init(): Promise<void>;
    set(timer: Timer): Promise<void>;
    wipe(): Promise<void>;
}

Implemented by

Index

Methods

delete destroy get getAll getAllOf init set wipe

Methods

delete

delete(kind: TimerKind, name: string): Promise<IDeleteResult>
Parameters
- kind: TimerKind
- name: string
Returns Promise<IDeleteResult>
- Defined in src/structures/stores/ITimerStore.ts:18

destroy

destroy(): Promise<void>
Returns Promise<void>
- Defined in src/structures/stores/ITimerStore.ts:13

get

get(kind: TimerKind, name: string): Promise<Timer | null>
Parameters
- kind: TimerKind
- name: string
Returns Promise<Timer | null>
- Defined in src/structures/stores/ITimerStore.ts:14

getAll

getAll(): Promise<Timer[]>
Returns Promise<Timer[]>
- Defined in src/structures/stores/ITimerStore.ts:15

getAllOf

getAllOf(kind: TimerKind): Promise<Timer[]>
Parameters
- kind: TimerKind
Returns Promise<Timer[]>
- Defined in src/structures/stores/ITimerStore.ts:16

init

init(): Promise<void>
Returns Promise<void>
- Defined in src/structures/stores/ITimerStore.ts:12

set

set(timer: Timer): Promise<void>
Parameters
- timer: Timer
Returns Promise<void>
- Defined in src/structures/stores/ITimerStore.ts:17

wipe

wipe(): Promise<void>
Returns Promise<void>
- Defined in src/structures/stores/ITimerStore.ts:19