Interface BaseStoreInterface<K, V>

⚠️ Deprecated ⚠️

For backwards compatibility only. Remove on next minor version upgrade.

This feature is deprecated and will be removed in the future.

It is not recommended for use.

interface BaseStoreInterface<K, V> {
    mdelete(keys): Promise<void>;
    mget(keys): Promise<(undefined | V)[]>;
    mset(keyValuePairs): Promise<void>;
    yieldKeys(prefix?): AsyncGenerator<string | K, any, unknown>;
}

Type Parameters

  • K

  • V

Implemented by

Methods

mdelete mget mset yieldKeys

Methods

mdelete

  • mdelete(keys): Promise<void>

  • Method to delete multiple keys.

    Parameters

    • keys: K[]

      An array of keys to delete.

    Returns Promise<void>

    • A Promise that resolves when the operation is complete.

mget

  • mget(keys): Promise<(undefined | V)[]>

  • Method to get multiple values for a set of keys.

    Parameters

    • keys: K[]

      An array of keys.

    Returns Promise<(undefined | V)[]>

    • A Promise that resolves with array of values or undefined if key not found.

mset

  • mset(keyValuePairs): Promise<void>

  • Method to set a value for multiple keys.

    Parameters

    • keyValuePairs: [K, V][]

      An array of key-value pairs.

    Returns Promise<void>

    • A Promise that resolves when the operation is complete.

yieldKeys

  • yieldKeys(prefix?): AsyncGenerator<string | K, any, unknown>

  • Method to yield keys optionally based on a prefix.

    Parameters

    • Optional prefix: string

      Optional prefix to filter keys.

    Returns AsyncGenerator<string | K, any, unknown>

    • An asynchronous generator that yields keys on iteration.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc