Class IndexedDb

Implements

IIndexedDb

Index

Constructors

Properties

Name Version database indexedDbFactory migrations

Accessors

Methods

Connect Delete Disconnect Get GetAll Insert Update executeTransaction setOpenRequestHandlers Instance

Constructors

`Private` constructor

new IndexedDb(Name, Version, migrations, indexedDbFactory): IndexedDb
Parameters
- Name: string
- Version: number
- migrations: Migration[]
- indexedDbFactory: IDBFactory
Returns IndexedDb
- Defined in src/Persistence/IndexedDb/IndexedDb.ts:23

Properties

Name

Name: string

Name of the database to connect to.

Version

Version: number

Version of the database to run. Migrations up to and including this version will be executed on connection.

`Private` database

database: null | IDBDatabase = null

`Private` indexedDbFactory

indexedDbFactory: IDBFactory

`Private` migrations

migrations: Migration[]

Accessors

Connected

get Connected(): boolean
Returns boolean
Implementation of IIndexedDb.Connected
- Defined in src/Persistence/IndexedDb/IndexedDb.ts:19

Methods

Connect

Connect(): Promise<Result<null | IDBDatabase>>
Connect to the database configured by the Name and Version properties.

Returns Promise<Result<null | IDBDatabase>>
Implementation of IIndexedDb.Connect
- Defined in src/Persistence/IndexedDb/IndexedDb.ts:30

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>>
Implementation of IIndexedDb.Delete
- Defined in src/Persistence/IndexedDb/IndexedDb.ts:114

Disconnect

Disconnect(): void
Close the connection to the database

Returns void
Implementation of IIndexedDb.Disconnect
- Defined in src/Persistence/IndexedDb/IndexedDb.ts:144

Get

Get<T>(storeName, query): 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) => boolean)
Returns Promise<Result<null | T | T[]>>
Implementation of IIndexedDb.Get
- Defined in src/Persistence/IndexedDb/IndexedDb.ts:58

GetAll

GetAll<T>(storeName): Promise<Result<T[]>>
Get all records from a specified store
Type Parameters
- T
Parameters
- storeName: string
Returns Promise<Result<T[]>>
Implementation of IIndexedDb.GetAll
- Defined in src/Persistence/IndexedDb/IndexedDb.ts:94

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>>
Implementation of IIndexedDb.Insert
- Defined in src/Persistence/IndexedDb/IndexedDb.ts:44

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>>
Implementation of IIndexedDb.Update
- Defined in src/Persistence/IndexedDb/IndexedDb.ts:129

`Private` executeTransaction

executeTransaction(storeNames, command): Promise<Result<null>>
Parameters
- storeNames: string[]
- command: ((transaction) => void)
  - - (transaction): void
    - Parameters
      transaction: IDBTransaction
      Returns void
Returns Promise<Result<null>>
- Defined in src/Persistence/IndexedDb/IndexedDb.ts:165

`Private` setOpenRequestHandlers

setOpenRequestHandlers(openRequest, migrations): void
Parameters
- openRequest: IDBOpenDBRequest
- migrations: Migration[]
Returns void
- Defined in src/Persistence/IndexedDb/IndexedDb.ts:149

`Static` Instance

Instance(name, version, migrations, indexedDbFactory?): IIndexedDb
Parameters
- name: string
- version: number
- migrations: Migration[]
- indexedDbFactory: IDBFactory = indexedDB
Returns IIndexedDb
- Defined in src/Persistence/IndexedDb/IndexedDb.ts:9

Generated using TypeDoc