Class IndexedDb

Name

Version

Connected

• get Connected(): boolean

  Returns boolean

Connect

• Connect(): Promise<Result<null | IDBDatabase>>

  Connect to the database configured by the Name and Version properties.

  Returns Promise<Result<null | IDBDatabase>>

Delete

• Delete(deletions: Record<string, string[]>): Promise<Result<null>>

  Deletes a map (storeName => object[]) of objects from the specified store(s).

  Parameters

  • deletions: Record<string, string[]>

  Returns Promise<Result<null>>

Disconnect

• Disconnect(): void

  Close the connection to the database

  Returns void

Get

• Get<T>(
      storeName: string,
      query: string | number | ((t: T) => boolean),
  ): Promise<Result<null | T | T[]>>

  Get a record by key or records by query from a specified store

  Type Parameters

  • T

  Parameters

  • storeName: string
  • query: string | number | ((t: T) => boolean)

  Returns Promise<Result<null | T | T[]>>

GetAll

• GetAll<T>(storeName: string): Promise<Result<T[]>>

  Get all records from a specified store

  Type Parameters

  • T

  Parameters

  • storeName: string

  Returns Promise<Result<T[]>>

Insert

• Insert(insertions: Record<string, object[]>): Promise<Result<null>>

  Inserts a map (storeName => object[]) of objects into the specified store(s).

  Parameters

  • insertions: Record<string, object[]>

  Returns Promise<Result<null>>

Update

• Update(updates: Record<string, object[]>): Promise<Result<null>>

  Updates a map (storeName => object[]) of objects in the specified store(s).

  Parameters

  • updates: Record<string, object[]>

  Returns Promise<Result<null>>

StaticInstance

• Instance(
      name: string,
      version: number,
      migrations: Migration[],
      indexedDbFactory?: IDBFactory,
  ): IIndexedDb

  Parameters

  • name: string
  • version: number
  • migrations: Migration[]
  • indexedDbFactory: IDBFactory = indexedDB

  Returns IIndexedDb