Interface IDatabaseTable<T>

Interface for a key-value database table.

interface IDatabaseTable<T> {
    add(value): Promise<T>;
    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>;
    subscribe(callback): void;
    unsubscribe(): void;
}

Type Parameters

Methods

add clear count delete get list set subscribe unsubscribe

Methods

add

  • add(value): Promise<T>

  • Add a value to the database.

    Parameters

    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

    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

set

  • set(key, value): Promise<T>

  • Set the value for a key.

    Parameters

    Returns Promise<T>

    A promise that resolves with the value set.

subscribe

  • subscribe(callback): void

  • Subscribe to changes in the database table.

    Parameters

    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

Settings

Member Visibility

Theme

On This Page

addclearcountdeletegetlistsetsubscribeunsubscribe

Generated using TypeDoc