Class UpstashRedisStore

Class that extends the BaseStore class to interact with an Upstash Redis database. It provides methods for getting, setting, and deleting data, as well as yielding keys from the database.

Hierarchy

  • BaseStore<string, Uint8Array>
    • UpstashRedisStore

Constructors

constructor

Properties

client yieldKeysScanBatchSize namespace?

Methods

mdelete mget mset toJSON toJSONNotImplemented yieldKeys

Constructors

constructor

Properties

Protected client

client: Redis

Protected yieldKeysScanBatchSize

yieldKeysScanBatchSize: number = 1000

Protected Optional namespace

namespace?: string

Methods

mdelete

  • Deletes multiple keys from the Upstash Redis database.

    Parameters

    • keys: string[]

      Array of keys to be deleted.

    Returns Promise<void>

    Promise that resolves when all keys have been deleted.

mget

  • Gets multiple keys from the Upstash Redis database.

    Parameters

    • keys: string[]

      Array of keys to be retrieved.

    Returns Promise<(undefined | Uint8Array)[]>

    An array of retrieved values.

mset

  • Sets multiple keys in the Upstash Redis database.

    Parameters

    • keyValuePairs: [string, Uint8Array][]

      Array of key-value pairs to be set.

    Returns Promise<void>

    Promise that resolves when all keys have been set.

toJSON

toJSONNotImplemented

yieldKeys

  • Yields keys from the Upstash Redis database.

    Parameters

    • Optional prefix: string

      Optional prefix to filter the keys. A wildcard (*) is always appended to the end.

    Returns AsyncGenerator<string, any, unknown>

    An AsyncGenerator that yields keys from the Upstash Redis database.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc