PURISTA API / Modules / @purista/redis-state-store

Module: @purista/redis-state-store

A state store for using redis as storage. State values are stored as stringified JSON.

Per default, setting/changing and removal of values are enabled.

Example

const config = {
 enableGet: true, // optional, default is true
 enableRemove: true, // optional, default is true
 enableSet: true, // optional, default is true
 url: 'redis://alice:foobared@awesome.redis.server:6379'
}

const store = new RedisStateStore(config)

await store.setState('stateKey',{ myState: 'value' })

let value = await store.getState('stateKey')
console.log(value) // outputs: { myState: 'value' }

await store.removeState('stateKey')

value = await store.getState('stateKey')
console.log(value) // outputs: undefined

See documentation of underlaying redis lib package for detailed configuration options.

See

NODE-REDIS

Table of contents

Classes

• RedisStateStore

Type Aliases

• RedisStoreConfig

Type Aliases

RedisStoreConfig

Ƭ RedisStoreConfig<M, F, S>: Object

The redis state store configuration. It will extend the StoreBaseConfig.

Type parameters

Name	Type
M	extends RedisModules = RedisModules
F	extends RedisFunctions = RedisFunctions
S	extends RedisScripts = RedisScripts

Type declaration

Name	Type
config?	RedisClientOptions<M, F, S>

Defined in

redis-state-store/src/types.ts:7