PURISTA API / @purista/core / StateStore
Interface: StateStore
Defined in: packages/core/src/core/StateStore/types/StateStore.ts:10
Interface definition for state store implementations
Properties
getState
getState:
StateGetterFunction
Defined in: packages/core/src/core/StateStore/types/StateStore.ts:19
get a state value
Param
name of state
Returns
the state
Throws
UnhandledError
name
name:
string
Defined in: packages/core/src/core/StateStore/types/StateStore.ts:12
name of store
removeState
removeState:
StateDeleteFunction
Defined in: packages/core/src/core/StateStore/types/StateStore.ts:26
delete a state value
Param
name of state
Throws
UnhandledError
setState
setState:
StateSetterFunction
Defined in: packages/core/src/core/StateStore/types/StateStore.ts:34
set a state value
Param
name of state
Param
value of state
Throws
UnhandledError
Methods
destroy()
destroy():
Promise<void>
Defined in: packages/core/src/core/StateStore/types/StateStore.ts:39
disconnects and shuts down the state store
Returns
Promise<void>