Interface DatabaseInterface

interface DatabaseInterface {
    close(): Promise<void>;
    deleteAllRulesets(): Promise<void>;
    deleteRuleset(id: string): Promise<void>;
    getRuleset(id: string): Promise<undefined | Ruleset>;
    listRulesets(): Promise<Ruleset[]>;
    saveRuleset(id: string, data: Ruleset): Promise<void>;
}

Index

Methods

close deleteAllRulesets deleteRuleset getRuleset listRulesets saveRuleset

Methods

close

close(): Promise<void>
Closes the connection to the Database.

Returns Promise<void>
- Defined in persistent-rita/src/DatabaseInterface.ts:35

deleteAllRulesets

deleteAllRulesets(): Promise<void>
Deletes all rulesets.

Returns Promise<void>
- Defined in persistent-rita/src/DatabaseInterface.ts:30

deleteRuleset

deleteRuleset(id): Promise<void>
Deletes a ruleset with the given ID.
Parameters
- id: string
  The ID of the ruleset
Returns Promise<void>
- Defined in persistent-rita/src/DatabaseInterface.ts:25

getRuleset

getRuleset(id): Promise<undefined | Ruleset>
Gets a specific ruleset by it ID. If there is no ruleset with this ID, undefined will be returned.
Parameters
- id: string
  The ID of the ruleset
Returns Promise<undefined | Ruleset>
- Defined in persistent-rita/src/DatabaseInterface.ts:12

listRulesets

listRulesets(): Promise<Ruleset[]>
Returns a list containing all rulesets.

Returns Promise<Ruleset[]>
- Defined in persistent-rita/src/DatabaseInterface.ts:6

saveRuleset

saveRuleset(id, data): Promise<void>
Saves a ruleset with the given ID. If it already exists it will be updated, otherwise it will be created.
Parameters
- id: string
  The ID of the ruleset
- data: Ruleset
  The actual ruleset
Returns Promise<void>
- Defined in persistent-rita/src/DatabaseInterface.ts:19