Skip to main content

Interface: StateStore


PURISTA API / Modules / @purista/core / StateStore

Interface: StateStore

@purista/core.StateStore

Interface definition for state store implementations

Implemented by

Table of contents

Properties

Methods

Properties

getState

getState: StateGetterFunction

get a state value

Param

name of state

Throws

UnhandledError

Defined in

core/StateStore/types/StateStore.ts:19open in new window


name

name: string

name of store

Defined in

core/StateStore/types/StateStore.ts:12open in new window


removeState

removeState: StateDeleteFunction

delete a state value

Param

name of state

Throws

UnhandledError

Defined in

core/StateStore/types/StateStore.ts:26open in new window


setState

setState: StateSetterFunction

set a state value

Param

name of state

Param

value of state

Throws

UnhandledError

Defined in

core/StateStore/types/StateStore.ts:34open in new window

Methods

destroy

destroy(): Promise<void>

disconnects and shuts down the state store

Returns

Promise<void>

Defined in

core/StateStore/types/StateStore.ts:39open in new window

Last update:
Contributors: Sebastian Wessel