Interface IKeyValueDatabaseTableConnector<T>

The key-value database table connector interface.

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

Type Parameters

Methods

add calculateSize clear count delete get list set

Methods

add

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

    • Optional query: 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

    • Optional query: 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

Settings

Member Visibility

Theme

On This Page

addcalculateSizeclearcountdeletegetlistset

Generated using TypeDoc