Interface IKeyValueDatabaseTableConnector<T>

The key-value database table connector interface.

interface IKeyValueDatabaseTableConnector<T> {
    add(value: ValueTypeOmitId<T>): Promise<T>;
    calculateSize(): Promise<number>;
    clear(): Promise<void>;
    count(query?: IDatabaseTableQuery): Promise<number>;
    delete(key: string): Promise<void>;
    get(key: string): Promise<undefined | T>;
    list(query?: IDatabaseTableQuery): Promise<T[]>;
    set(key: string, value: ValueTypeOmitId<T>): Promise<T>;
}

Type Parameters

T extends IValueType

Index

Methods

add calculateSize clear count delete get list set

Methods

add

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

calculateSize

calculateSize(): Promise<number>
Calculate the size of the table.

Returns Promise<number>
A promise that resolves with the size of the table in bytes.

clear

clear(): Promise<void>
Clear the database. Fires a IDatabaseTableEvent for each key deleted.

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

count

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

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, or undefined if the key was not found.

list

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

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 a SupportedIndexType.
Returns Promise<T>