Class ApiXRedisStore`Beta`

An implementation of a Redis store.

Implements

ApiXCache

Index

Constructors

Methods

connect removeValueForKey setValueForKey valueForKey

Constructors

constructor

new ApiXRedisStore(url?, password?): ApiXRedisStore
Beta
Create an instance of a Redis cache.
Parameters
- url: string = 'redis://localhost:6379'
  The URL for the redis cache. Defaults to redis://localhost:6379.
- Optionalpassword: string
  An optional password (if protected).
Returns ApiXRedisStore
- Defined in src/apixlib/common/ApiXRedisStore.ts:18

Methods

connect

connect(): Promise<void>
Beta
Connects to the Redis server.

Returns Promise<void>
- Defined in src/apixlib/common/ApiXRedisStore.ts:25

removeValueForKey

removeValueForKey(key): Promise<void>
Beta
Removes the value for the specified key. If the key does not exist, the method gracefully fails.
Parameters
- key: string
  The key in the store
Returns Promise<void>
Implementation of ApiXCache.removeValueForKey
- Defined in src/apixlib/common/ApiXRedisStore.ts:36

setValueForKey

setValueForKey(value, key, timeToLive?): Promise<void>
Beta
Sets a value from the key in the key-value pair store.
Parameters
- value: ApiXCacheValue
  The value to add to the store
- key: string
  The key in the store
- OptionaltimeToLive: number
  Time to remove from cache
Returns Promise<void>
Implementation of ApiXCache.setValueForKey
- Defined in src/apixlib/common/ApiXRedisStore.ts:29

valueForKey

valueForKey(key): Promise<undefined | ApiXCacheValue>
Beta
Gets the value from the key-value pair store.
Parameters
- key: string
  The key in the store
Returns Promise<undefined | ApiXCacheValue>
value, if it exists in the store
Implementation of ApiXCache.valueForKey
- Defined in src/apixlib/common/ApiXRedisStore.ts:40