Interface StorageItem<State, JSONState>

Type parameters

State
JSONState

Hierarchy

StorageItem

Index

Methods

Methods

fromJSON

fromJSON(obj: Partial<JSONState>): void

- Defined in src/store/index.ts:98
recover the state from its JSON representation

An object that has all or some properties of the JSONState will be passed as a parameter. The missing properties will be assigned with the value returned by the getDefault method.

Parameters
- obj: Partial<JSONState>
Returns void

getDefault

getDefault(): State

- Defined in src/store/index.ts:87
a method to obtain the default state

Returns State

toJSON

toJSON(this: StoreModule<State, JSONState>): JSONState

- Defined in src/store/index.ts:91
serialize this (the store module) to its JSON representation

Parameters
- this: StoreModule<State, JSONState>
Returns JSONState

Generated using TypeDoc