Class ZDatabaseForage

Represents an implementation of an IZMemoryDatabase that references the indexed db feature of browsers.

Implements

IZDatabaseMemory

Index

Constructors

Methods

delete read upsert

Constructors

constructor

new ZDatabaseForage(options): ZDatabaseForage
Initializes a new instance of this object.
Parameters
- options: IZDatabaseOptions
  The database options to configure forage indexes.
Returns ZDatabaseForage
- Defined in database-forage/database-forage.mts:15

Methods

delete

delete(key?): Promise<void>
Deletes a key in the database or deletes all keys in the database.
Parameters
- Optional key: string
  The key to delete. If this is undefined, then all keys should be deleted.
Returns Promise<void>
Implementation of IZDatabaseMemory.delete
- Defined in database-forage/database-forage.mts:41

read

read<T>(key, fallback?): Promise<null | T>
Gets the value of a specific key in the database.
Type Parameters
- T
Parameters
- key: string
  The key to retrieve.
- Optional fallback: T
Returns Promise<null | T>
The value of the given key, null if no such value exists and no fallback was provided.
Implementation of IZDatabaseMemory.read
- Defined in database-forage/database-forage.mts:21

upsert

upsert<T>(key, value): Promise<T>
Creates or updates a key value.
Type Parameters
- T
Parameters
- key: string
  The key to update.
- value: T
  The value to set.
Returns Promise<T>
The value that was written.
Implementation of IZDatabaseMemory.upsert
- Defined in database-forage/database-forage.mts:36

Generated using TypeDoc