Class ZDatabaseJsonFile

Represents a memory database where the data is housed in a single json file.

Implements

IZDatabaseMemory

Index

Constructors

Methods

delete read upsert

Constructors

constructor

new ZDatabaseJsonFile(_options): ZDatabaseJsonFile
Initializes a new instance of this object.
Parameters
- _options: IZDatabaseOptions
  The options for the database. The url is the only field used.
Returns ZDatabaseJsonFile
- Defined in database-json-file/database-json-file.mts:16

Methods

delete

delete(key?): Promise<void>
Deletes a key in the database or deletes all keys in the database.
Parameters
- Optionalkey: 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-json-file/database-json-file.mts:38

read

read<T>(key): Promise<null | T>
Gets the value of a specific key in the database.
Type Parameters
- T
Parameters
- key: string
  The key to retrieve.
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-json-file/database-json-file.mts:18
read<T>(key, fallback): Promise<T>
Gets the value of a specific key in the database.
Type Parameters
- T
Parameters
- key: string
  The key to retrieve.
- fallback: T
  The fallback value. If the key does not exist in the database, then this will be inserted automatically.
Returns Promise<T>
The value of the given key or the inserted fallback value if the key does not exist.
Implementation of IZDatabaseMemory.read
- Defined in database-json-file/database-json-file.mts:19

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-json-file/database-json-file.mts:31