Class MongoDBStore

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

Example

Hierarchy (view full)

Constructors

constructor

Properties

collection primaryKey yieldKeysScanBatchSize namespace?

Methods

mdelete mget mset yieldKeys

Constructors

constructor

Properties

collection

collection: Collection<Document>

primaryKey

primaryKey: string = "_id"

Protected yieldKeysScanBatchSize

yieldKeysScanBatchSize: number = 1000

Protected Optional namespace

namespace?: string

Methods

mdelete

  • mdelete(keys): Promise<void>

  • Deletes multiple keys from the MongoDB database.

    Parameters

    • keys: string[]

      Array of keys to be deleted.

    Returns Promise<void>

    Promise that resolves when all keys have been deleted.

mget

  • mget(keys): Promise<any[]>

  • Gets multiple keys from the MongoDB database.

    Parameters

    • keys: string[]

      Array of keys to be retrieved.

    Returns Promise<any[]>

    An array of retrieved values.

mset

  • mset(keyValuePairs): Promise<void>

  • Sets multiple keys in the MongoDB database.

    Parameters

    • keyValuePairs: [string, DocumentInterface][]

      Array of key-value pairs to be set.

    Returns Promise<void>

    Promise that resolves when all keys have been set.

yieldKeys

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

  • Yields keys from the MongoDB 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 MongoDB database.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc