Class BaseStore<T>

BaseStore class to manage state in a unified location

Type parameters

T: {}

Hierarchy

BaseStore

Index

Constructors

constructor

Methods

Constructors

Protected constructor

new BaseStore(initialState: T): BaseStore

- Defined in src/store/base-store.ts:13
Must be overridden. Takes in an initial state.

Parameters
- initialState: T
  
  state to start store with
Returns BaseStore

Methods

Protected _dispatch

_dispatch(state: Partial<T>): void

- Defined in src/store/base-store.ts:82
deprecated

use dispatch instead

Parameters
- state: Partial<T>
Returns void

destroy

destroy(): void

- Defined in src/store/base-store.ts:45
Destory the state and call .complete() on the state's underlying observable

NOTE: once this is called, the store cannot be reused

Returns void

Protected dispatch

dispatch(state: Partial<T>): void

- Defined in src/store/base-store.ts:70
Change part of the state to the passed in value.

This will create a shallow copy of the current state and set all properties of the new passed in state using the spread operator.

Throws an error if called when the store has already been destroyed (using .destroy()).

Parameters
- state: Partial<T>
  
  partial state to change
Returns void

getState

getState(): WithPreviousState<T>

- Defined in src/store/base-store.ts:34
Get the state synchonously

Returns WithPreviousState<T>

getState$

getState$(): Observable<WithPreviousState<T>>

- Defined in src/store/base-store.ts:27
Get the state as an observable

Returns Observable<WithPreviousState<T>>

hasDestroyed

hasDestroyed(): boolean

- Defined in src/store/base-store.ts:54
Check to see if the store has been destroyed. If it has been, it can no longer be used.

Returns boolean

Generated using TypeDoc