Class InMemoryDocstore

Class for storing and retrieving documents in memory asynchronously. Extends the Docstore class.

Hierarchy

Implements

Constructors

constructor

Methods

add mdelete mget mset search yieldKeys

Constructors

constructor

Methods

add

  • Adds new documents to the store.

    Parameters

    • texts: Record<string, Document<Record<string, any>>>

      An object where the keys are document IDs and the values are the documents themselves.

    Returns Promise<void>

    Void

mdelete

  • Method to delete multiple keys.

    Parameters

    • _keys: string[]

      An array of keys to delete.

    Returns Promise<void>

    • A Promise that resolves when the operation is complete.

mget

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

    Parameters

    • keys: string[]

      An array of keys.

    Returns Promise<Document<Record<string, any>>[]>

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

mset

  • Method to set a value for multiple keys.

    Parameters

    • keyValuePairs: [string, Document<Record<string, any>>][]

      An array of key-value pairs.

    Returns Promise<void>

    • A Promise that resolves when the operation is complete.

search

  • Searches for a document in the store based on its ID.

    Parameters

    • search: string

      The ID of the document to search for.

    Returns Promise<Document<Record<string, any>>>

    The document with the given ID.

yieldKeys

  • Method to yield keys optionally based on a prefix.

    Parameters

    • Optional _prefix: string

      Optional prefix to filter keys.

    Returns AsyncGenerator<string, any, unknown>

    • An asynchronous generator that yields keys on iteration.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc