Interface IIndexedDb

Connected

Name

Version

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): 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, query): Promise<Result<null | T>>

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

  Type Parameters

  • T

  Parameters

  • storeName: string

  • query: number

  Returns Promise<Result<null | T>>
• Get<T>(storeName, query): Promise<Result<null | T>>

• Type Parameters

  • T

  Parameters

  • storeName: string

  • query: string

  Returns Promise<Result<null | T>>

• Get<T>(storeName, query): Promise<Result<T[]>>

• Type Parameters

  • T

  Parameters

  • storeName: string

  • query: ((t) => boolean)

    • • (t): boolean

      • Parameters

        • t: T

        Returns boolean

  Returns Promise<Result<T[]>>

GetAll

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

• Get all records from a specified store

  Type Parameters

  • T

  Parameters

  • storeName: string

  Returns Promise<Result<T[]>>

Insert

• Insert(insertions): 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): Promise<Result<null>>

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

  Parameters

  • updates: Record<string, object[]>

  Returns Promise<Result<null>>