PURISTA API / Modules / @purista/core / StateStore

Interface: StateStore

@purista/core.StateStore

Interface definition for state store implementations

Implemented by

• StateStoreBaseClass

Table of contents

Properties

• getState
• name
• removeState
• setState

Methods

• destroy

Properties

getState

• getState: StateGetterFunction

get a state value

Param

name of state

Throws

UnhandledError

Defined in

core/StateStore/types/StateStore.ts:19

---

name

• name: string

name of store

Defined in

core/StateStore/types/StateStore.ts:12

---

removeState

• removeState: StateDeleteFunction

delete a state value

Param

name of state

Throws

UnhandledError

Defined in

core/StateStore/types/StateStore.ts:26

---

setState

• setState: StateSetterFunction

set a state value

Param

name of state

Param

value of state

Throws

UnhandledError

Defined in

core/StateStore/types/StateStore.ts:34

Methods

destroy

▸ destroy(): Promise<void>

disconnects and shuts down the state store

Returns

Promise<void>

Defined in

core/StateStore/types/StateStore.ts:39