Class ZDatabaseRedis

Represents a connection to a redis database.

Implements

IZDatabaseMemory

Index

Constructors

Properties

Methods

_do delete read upsert

Constructors

constructor

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

Properties

`Private` _client

_client: RedisClientType

Methods

`Private` _do

_do<T>(fn): Promise<T>
Type Parameters
- T
Parameters
- fn: (() => Promise<T>)
  - - (): Promise<T>
    - Returns Promise<T>
Returns Promise<T>
- Defined in database-redis/database-redis.mts:59

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-redis/database-redis.mts:48

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-redis/database-redis.mts:22

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-redis/database-redis.mts:40

Generated using TypeDoc