Class ZDatabaseRedis

Represents a connection to a redis database.

Implements

IZDatabaseMemory

Index

Constructors

Methods

delete read upsert

Constructors

constructor

new ZDatabaseRedis(options: IZDatabaseOptions): ZDatabaseRedis
Initializes a new instance of this object.
Parameters
- options: IZDatabaseOptions
  The connection options for this database.
Returns ZDatabaseRedis
- Defined in database-redis.mts:17

Methods

delete

delete(key?: string): 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-redis.mts:49

read

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

upsert

upsert<T>(key: string, value: T): 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-redis.mts:41