PURISTA

Appearance

@purista/core v2.0.5

PURISTA API / @purista/core / DefaultStateStore

Class: DefaultStateStore ​

Defined in: packages/core/src/DefaultStateStore/DefaultStateStore.impl.ts:13

The DefaultStateStore is a placeholder which offers all needed methods. Getters and setters will throw a UnhandledError with status Not implemented

Extends ​

Implements ​

Constructors ​

new DefaultStateStore() ​

new DefaultStateStore(config?): DefaultStateStore

Defined in: packages/core/src/DefaultStateStore/DefaultStateStore.impl.ts:15

Parameters ​

config? ​
cacheTtl? ​

number

Cache time to live in ms

enableCache? ​

boolean

Enable cache

enableGet? ​

boolean

Enable generally get method

enableRemove? ​

boolean

Enable generally remove method

enableSet? ​

boolean

Enable generally set method

logger? ​

Logger

A logger instance

logLevel? ​

LogLevelName

A log level for new logger if logger is not set

Returns ​

DefaultStateStore

Overrides ​

StateStoreBaseClass.constructor

Properties ​

config ​

config: object

Defined in: packages/core/src/core/StateStore/StateStoreBaseClass.impl.ts:20

Index Signature ​

[key: string]: unknown

cacheTtl? ​

optional cacheTtl: number

Cache time to live in ms

enableCache? ​

optional enableCache: boolean

Enable cache

enableGet? ​

optional enableGet: boolean

Enable generally get method

enableRemove? ​

optional enableRemove: boolean

Enable generally remove method

enableSet? ​

optional enableSet: boolean

Enable generally set method

logger? ​

optional logger: Logger

A logger instance

logLevel? ​

optional logLevel: LogLevelName

A log level for new logger if logger is not set

Inherited from ​

StateStoreBaseClass.config

logger ​

logger: Logger

Defined in: packages/core/src/core/StateStore/StateStoreBaseClass.impl.ts:19

Inherited from ​

StateStoreBaseClass.logger

name ​

name: string

Defined in: packages/core/src/core/StateStore/StateStoreBaseClass.impl.ts:22

name of store

Implementation of ​

StateStore.name

Inherited from ​

StateStoreBaseClass.name

Methods ​

destroy() ​

destroy(): Promise<void>

Defined in: packages/core/src/core/StateStore/StateStoreBaseClass.impl.ts:82

disconnects and shuts down the state store

Returns ​

Promise<void>

Implementation of ​

StateStore.destroy

Inherited from ​

StateStoreBaseClass.destroy

getState() ​

getState<StateNames>(...stateNames): Promise<ObjectWithKeysFromStringArray<StateNames>>

Defined in: packages/core/src/core/StateStore/StateStoreBaseClass.impl.ts:43

get a state value

Type Parameters ​

• StateNames extends string[]

Parameters ​

stateNames ​

...StateNames

Returns ​

Promise<ObjectWithKeysFromStringArray<StateNames>>

Param ​

name of state

Throws ​

UnhandledError

Implementation of ​

StateStore.getState

Inherited from ​

StateStoreBaseClass.getState

getStateImpl() ​

protected getStateImpl<StateNames>(...stateNames): Promise<ObjectWithKeysFromStringArray<StateNames>>

Defined in: packages/core/src/DefaultStateStore/DefaultStateStore.impl.ts:25

Type Parameters ​

• StateNames extends string[]

Parameters ​

stateNames ​

...StateNames

Returns ​

Promise<ObjectWithKeysFromStringArray<StateNames>>

Overrides ​

StateStoreBaseClass.getStateImpl

removeState() ​

removeState(stateName): Promise<void>

Defined in: packages/core/src/core/StateStore/StateStoreBaseClass.impl.ts:58

delete a state value

Parameters ​

stateName ​

string

Returns ​

Promise<void>

Param ​

name of state

Throws ​

UnhandledError

Implementation of ​

StateStore.removeState

Inherited from ​

StateStoreBaseClass.removeState

removeStateImpl() ​

protected removeStateImpl(stateName): Promise<void>

Defined in: packages/core/src/DefaultStateStore/DefaultStateStore.impl.ts:39

Parameters ​

stateName ​

string

Returns ​

Promise<void>

Overrides ​

StateStoreBaseClass.removeStateImpl

setState() ​

setState(stateName, stateValue): Promise<void>

Defined in: packages/core/src/core/StateStore/StateStoreBaseClass.impl.ts:72

set a state value

Parameters ​

stateName ​

string

stateValue ​

unknown

Returns ​

Promise<void>

Param ​

name of state

Param ​

value of state

Throws ​

UnhandledError

Implementation of ​

StateStore.setState

Inherited from ​

StateStoreBaseClass.setState

setStateImpl() ​

protected setStateImpl(stateName, stateValue): Promise<void>

Defined in: packages/core/src/DefaultStateStore/DefaultStateStore.impl.ts:35

Parameters ​

stateName ​

string

stateValue ​

unknown

Returns ​

Promise<void>

Overrides ​

StateStoreBaseClass.setStateImpl