Class DummyRedisStorageService<T>

class DummyRedisStorageService

Use local redis server and non-default logical database

Type Parameters

T extends StorageModel

Hierarchy

RedisStorageService<T>
- DummyRedisStorageService

Index

Constructors

constructor

new DummyRedisStorageService<T>(): DummyRedisStorageService<T>
Public constructor
Type Parameters
- T extends StorageModel
Returns DummyRedisStorageService<T>
Overrides RedisStorageService.constructor
- Defined in src/cores/storage/redis-storage-service.ts:395

Properties

`Protected` `Readonly` redis

redis: Redis

ioredis client

`Readonly` `Private` tableName

tableName: string

Virtual table name

`Readonly` `Private` ttl

ttl: number

Default time to live of a model

`Static` `Readonly` CAS_MAX_RETRIES

CAS_MAX_RETRIES: 5 = 5

Maximum retry count of check-and-save behavior

Static

`Static` `Readonly` ENV_REDIS_ENDPOINT

ENV_REDIS_ENDPOINT: "MY_REDIS_ENDPOINT" = 'MY_REDIS_ENDPOINT'

Environment variable name for redis server endpoint

Static

`Static` `Private` dbIndex

dbIndex: number = 0

Database index. Each DummyRedisStorageService uses different logical database.

Methods

`Protected` asKey

asKey(id: string): string
Protected
Get redis key from id
Parameters
- id: string
Returns string
Inherited from RedisStorageService.asKey
- Defined in src/cores/storage/redis-storage-service.ts:275

delete

delete(id: string): Promise<T>
Delete a key

Returns
true on success
Parameters
- id: string
Returns Promise<T>
Inherited from RedisStorageService.delete
- Defined in src/cores/storage/redis-storage-service.ts:247

`Protected` deserialize

deserialize(data: Record<string, string>): T
Protected
Deserialize internal data into model
Parameters
- data: Record<string, string>
Returns T
Inherited from RedisStorageService.deserialize
- Defined in src/cores/storage/redis-storage-service.ts:296

hello

hello(): string
Say hello

Returns string
Overrides RedisStorageService.hello
- Defined in src/cores/storage/redis-storage-service.ts:405

increment

increment(id: string, increment: T, update?: T): Promise<T>
Increment the integer value of a key
Parameters
- id: string
- increment: T
  
  model to increment
- Optional update: T
  
  (optional) model to update
Returns Promise<T>
Inherited from RedisStorageService.increment
- Defined in src/cores/storage/redis-storage-service.ts:232

quit

quit(): Promise<void>
Disconnect from redis

Returns Promise<void>
Inherited from RedisStorageService.quit
- Defined in src/cores/storage/redis-storage-service.ts:113

read

read(id: string): Promise<T>
Read model by id
Parameters
- id: string
Returns Promise<T>
Inherited from RedisStorageService.read
- Defined in src/cores/storage/redis-storage-service.ts:122

readOrCreate

readOrCreate(id: string, model: T): Promise<T>
Read model or create if id does not exist
Parameters
- id: string
- model: T
Returns Promise<T>
Inherited from RedisStorageService.readOrCreate
- Defined in src/cores/storage/redis-storage-service.ts:142

save

save(id: string, model: T): Promise<T>
Create model and overwrite if id exists
Parameters
- id: string
- model: T
Returns Promise<T>
Inherited from RedisStorageService.save
- Defined in src/cores/storage/redis-storage-service.ts:187

`Protected` serialize

serialize(model: T): Record<string, string>
Protected
Serialize model into internal data
Parameters
- model: T
Returns Record<string, string>
Inherited from RedisStorageService.serialize
- Defined in src/cores/storage/redis-storage-service.ts:284

truncate

truncate(): Promise<void>
Delete all data in database

Returns Promise<void>
- Defined in src/cores/storage/redis-storage-service.ts:412

update

update(id: string, update: T, increment?: T): Promise<T>
Update existing model and create if id does not exist
Parameters
- id: string
- update: T
  
  model to update
- Optional increment: T
  
  (optional) model to increment
Returns Promise<T>
Inherited from RedisStorageService.update
- Defined in src/cores/storage/redis-storage-service.ts:216

Class DummyRedisStorageService<T>

Type Parameters

T extends StorageModel

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends StorageModel

Returns DummyRedisStorageService<T>

Properties

Protected Readonly redis

Readonly Private tableName

Readonly Private ttl

Static Readonly CAS_MAX_RETRIES

Static

Static Readonly ENV_REDIS_ENDPOINT

Static

Static Private dbIndex

Methods

Protected asKey

Parameters

id: string

Returns string

delete

Returns

Parameters

id: string

Returns Promise<T>

Protected deserialize

Parameters

data: Record<string, string>

Returns T

hello

Returns string

increment

Parameters

id: string

increment: T

Optional update: T

Returns Promise<T>

quit

Returns Promise<void>

read

Parameters

id: string

Returns Promise<T>

readOrCreate

Parameters

id: string

model: T

Returns Promise<T>

save

Parameters

id: string

model: T

Returns Promise<T>

Protected serialize

Parameters

model: T

Returns Record<string, string>

truncate

Returns Promise<void>

update

Parameters

id: string

update: T

Optional increment: T

Returns Promise<T>

Settings

Member Visibility

Theme

`Protected` `Readonly` redis

`Readonly` `Private` tableName

`Readonly` `Private` ttl

`Static` `Readonly` CAS_MAX_RETRIES

`Static` `Readonly` ENV_REDIS_ENDPOINT

`Static` `Private` dbIndex

`Protected` asKey

`Protected` deserialize

`Optional` update: T

`Protected` serialize

`Optional` increment: T