Interface StorageProvider

matrixStore

closeDB

• closeDB(): Promise<void>

  Close the database.

  Returns Promise<void>

createItem

• createItem(store: string, key: string, value: any): Promise<void>

  Create an item in the database.

  Parameters

  • store: string

    The store to create the item in.

  • key: string

    The key of the item to create.

  • value: any

    The value of the item to create.

  Returns Promise<void>

deleteItem

• deleteItem(store: string, key: string): Promise<void>

  Delete an item from the database.

  Parameters

  • store: string

    The store to delete the item from.

  • key: string

    The key of the item to delete.

  Returns Promise<void>

destroyDB

• destroyDB(): Promise<void>

  Destroy the database.

  Returns Promise<void>

getItem

• getItem<T>(store: string, key: string): Promise<T | undefined>

  Get an item from the database.

  Should be used when the value is expected to be a single item.

  Type Parameters

  • T

  Parameters

  • store: string

    The store to get the item from.

  • key: string

    The key of the item to get.

  Returns Promise<T | undefined>

  The item from the database.

getItems

• getItems<T>(
      store: string,
      key: string,
      limit?: number,
      offset?: number,
  ): Promise<T[]>

  Get items from the database.

  Should be used when the value is expected to be an array.

  Type Parameters

  • T

  Parameters

  • store: string

    The store to get the items from.

  • key: string

    The key of the item to get.

  • Optionallimit: number

    (optional) Number of items to get.

  • Optionaloffset: number

    (optional) Start index of the items to get.

  Returns Promise<T[]>

  The items from the database.

openDB

• openDB(): Promise<void>

  Open the database.

  Returns Promise<void>

updateItem

• updateItem(store: string, key: string, value: any): Promise<void>

  Update an item in the database.

  Parameters

  • store: string

    The store to update the item in.

  • key: string

    The key of the item to update.

  • value: any

    The value of the item to update.

  Returns Promise<void>