Interface IDatabaseTable<T>

Interface for a key-value database table.

interface IDatabaseTable<T> {
    add(value: ValueTypeOmitId<T>): Promise<T>;
    clear(): Promise<void>;
    count(query?: IDatabaseTableQuery | IQueryBuilder): Promise<number>;
    delete(key: string): Promise<void>;
    get(key: string): Promise<undefined | T>;
    list(query?: IDatabaseTableQuery | IQueryBuilder): Promise<T[]>;
    set(key: string, value: ValueTypeOmitId<T>): Promise<T>;
    subscribe(callback: ((event: IDatabaseTableEvent<T>) => void)): void;
    unsubscribe(): void;
}

Type Parameters

T extends IValueType

Index

Methods

add clear count delete get list set subscribe unsubscribe

Methods

add

add(value): Promise<T>
Add a value to the database.
Parameters
- value: ValueTypeOmitId<T>
  The value to add.
Returns Promise<T>
A promise that resolves with the value added.

clear

clear(): Promise<void>
Clear the database.

Returns Promise<void>
A promise that resolves when the database has been cleared.

count

count(query?): Promise<number>
Count the number of keys in the database.
Parameters
- Optionalquery: IDatabaseTableQuery | IQueryBuilder
  The query to use to filter the keys. If no query is provided, all the keys in the database are counted. The query can either be a IDatabaseTableQuery or a QueryBuilder.
Returns Promise<number>
A promise that resolves with the number of keys in the database.

delete

delete(key): Promise<void>
Delete a key.
Parameters
- key: string
  The key to delete.
Returns Promise<void>
A promise that resolves when the key has been deleted.

get

get(key): Promise<undefined | T>
Get the value for a key.
Parameters
- key: string
  The key to get the value for.
Returns Promise<undefined | T>
A promise that resolves with the value for the key.

list

list(query?): Promise<T[]>
Get all the values in the database.
Parameters
- Optionalquery: IDatabaseTableQuery | IQueryBuilder
  The query to use to filter the values. If no query is provided, all the values in the database are returned. The query can either be a IDatabaseTableQuery or a QueryBuilder.
Returns Promise<T[]>
A promise that resolves with all the values in the database.

set

set(key, value): Promise<T>
Set the value for a key.
Parameters
- key: string
  The key to set the value for.
- value: ValueTypeOmitId<T>
  The value to set for the key. It must be serializable.
Returns Promise<T>
A promise that resolves with the value set.

subscribe

subscribe(callback): void
Subscribe to changes in the database table.
Parameters
- callback: ((event: IDatabaseTableEvent<T>) => void)
  - - (event): void
    - Parameters
      event: IDatabaseTableEvent<T>
      Returns void
Returns void
Params
callback The callback to call when the database table changes.

unsubscribe

unsubscribe(): void
Unsubscribe from changes in the database table.

Returns void