Class LocalFileStore

constructor

• new LocalFileStore(fields): LocalFileStore

• Parameters

  • fields: {
        rootPath: string;
    }

    • rootPath: string

  Returns LocalFileStore

rootPath

mdelete

• mdelete(keys): Promise<void>

• Deletes the given keys and their associated values from the store.

  Parameters

  • keys: string[]

    Keys to delete from the store.

  Returns Promise<void>

  Promise that resolves when all keys have been deleted.

mget

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

• Retrieves the values associated with the given keys from the store.

  Parameters

  • keys: string[]

    Keys to retrieve values for.

  Returns Promise<(undefined | Uint8Array)[]>

  Array of values associated with the given keys.

mset

• mset(keyValuePairs): Promise<void>

• Sets the values for the given keys in the store.

  Parameters

  • keyValuePairs: [string, Uint8Array][]

    Array of key-value pairs to set in the store.

  Returns Promise<void>

  Promise that resolves when all key-value pairs have been set.

yieldKeys

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

• Asynchronous generator that yields keys from the store. If a prefix is provided, it only yields keys that start with the prefix.

  Parameters

  • Optional prefix: string

    Optional prefix to filter keys.

  Returns AsyncGenerator<string, any, unknown>

  AsyncGenerator that yields keys from the store.

Static fromPath

• fromPath(rootPath): Promise<LocalFileStore>

• Static method for initializing the class. Preforms a check to see if the directory exists, and if not, creates it.

  Parameters

  • rootPath: string

  Returns Promise<LocalFileStore>

  Promise that resolves to an instance of the class.