Skip to content

@epikodelabs/actionstack


@epikodelabs/actionstack / Store

Type Alias: Store<TState, TDependencies>

Store<TState, TDependencies> = object

Defined in: store.ts:51

The Store type represents the core store object that manages state, actions, and modules. It provides methods to interact with the store's state, dispatch actions, load/unload modules, and more.

Type Parameters

TState

TState = any

TDependencies

TDependencies = any

Properties

dispatch

dispatch: Dispatch<TState, TDependencies>

Defined in: store.ts:52


getState()

getState: {<R>(slice, callback): Promise<void>; <R>(slice, callback): Promise<void>; <R>(slice, callback): Promise<void>; }

Defined in: store.ts:54

Call Signature

<R>(slice, callback): Promise<void>

Type Parameters
R

R = any

Parameters
slice

"*"

callback

(state) => void

Returns

Promise<void>

Call Signature

<R>(slice, callback): Promise<void>

Type Parameters
R

R = any

Parameters
slice

string

callback

(state) => void

Returns

Promise<void>

Call Signature

<R>(slice, callback): Promise<void>

Type Parameters
R

R = any

Parameters
slice

readonly string[]

callback

(state) => void

Returns

Promise<void>


select()

select: {<R>(selector, defaultValue?): Stream<R>; <R>(selector, defaultValue?): Stream<R>; }

Defined in: store.ts:60

Call Signature

<R>(selector, defaultValue?): Stream<R>

Type Parameters
R

R = any

Parameters
selector

(state) => R

defaultValue?

R

Returns

Stream<R>

Call Signature

<R>(selector, defaultValue?): Stream<R>

Type Parameters
R

R = any

Parameters
selector

(state) => Promise<R>

defaultValue?

R

Returns

Stream<R>


populate()

populate: (...modules) => Promise<void>

Defined in: store.ts:65

Parameters

modules

...FeatureModule[]

Returns

Promise<void>


loadModule()

loadModule: (module) => Promise<void>

Defined in: store.ts:66

Parameters

module

FeatureModule

Returns

Promise<void>


unloadModule()

unloadModule: (module, clearState?) => Promise<void>

Defined in: store.ts:67

Parameters

module

FeatureModule

clearState?

boolean

Returns

Promise<void>


addReducer()

addReducer: (reducer) => void

Defined in: store.ts:69

Parameters

reducer

(state, action) => TState | Promise<TState>

Returns

void


middlewareAPI

middlewareAPI: MiddlewareAPI

Defined in: store.ts:71


starter

starter: Middleware

Defined in: store.ts:72


tracker?

optional tracker: Tracker

Defined in: store.ts:73

Released under the MIT License.