Class RedisStorageService<T>

class RedisStorageService

Type Parameters

T extends StorageModel

Hierarchy

RedisStorageService
- DummyRedisStorageService

Implements

StorageService<T>

Index

Constructors

Properties

redis tableName ttl CAS_MAX_RETRIES ENV_REDIS_ENDPOINT

Methods

asKey delete deserialize hello increment prepareUpdatedModel quit read readOrCreate save serialize update updateCAS throwIfTransactionError

Constructors

constructor

new RedisStorageService<T>(options: RedisOptions): RedisStorageService<T>
Public constructor

Options
redis options
Type Parameters
- T extends StorageModel
Parameters
- options: RedisOptions
Returns RedisStorageService<T>
- Defined in src/cores/storage/redis-storage-service.ts:80

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

Methods

`Protected` asKey

asKey(id: string): string
Protected
Get redis key from id
Parameters
- id: string
Returns string
- 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>
Implementation of StorageService.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
- Defined in src/cores/storage/redis-storage-service.ts:296

hello

hello(): string
Say hello

Returns string
Implementation of StorageService.hello
- Defined in src/cores/storage/redis-storage-service.ts:106

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>
Implementation of StorageService.increment
- Defined in src/cores/storage/redis-storage-service.ts:232

`Private` prepareUpdatedModel

prepareUpdatedModel(orig: T, update?: T, increment?: T): T
Private
Prepare new model - original model + update + increment
Parameters
- orig: T
- Optional update: T
- Optional increment: T
Returns T
- Defined in src/cores/storage/redis-storage-service.ts:354

quit

quit(): Promise<void>
Disconnect from redis

Returns Promise<void>
- 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>
Implementation of StorageService.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>
Implementation of StorageService.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>
Implementation of StorageService.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>
- Defined in src/cores/storage/redis-storage-service.ts:284

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>
Implementation of StorageService.update
- Defined in src/cores/storage/redis-storage-service.ts:216

`Private` updateCAS

updateCAS(id: string, update?: T, increment?: T): Promise<T>
Private
Update key w/ check-and-save behavior and retries
Parameters
- id: string
- Optional update: T
  
  (optional) model to update
- Optional increment: T
  
  (optional) model to increment
Returns Promise<T>
- Defined in src/cores/storage/redis-storage-service.ts:310

`Static` `Private` throwIfTransactionError

throwIfTransactionError(results: [Error, any][]): void
Private
Check transaction results and throw if error occurred
Parameters
- results: [Error, any][]
  
  transaction pipeline execution results
Returns void
- Defined in src/cores/storage/redis-storage-service.ts:374

Generated using TypeDoc