Class ReduxStore<State, Event, Action>

ReduceStore with Redux-compatible interface.

Type Parameters

State
Event
Action = Event

Hierarchy

ReduceStore<State, Event>
- ReduxStore

Implements

ReactiveStore<State>
MessageDispatcher<Action>

Index

Constructors

Properties

bus eventBus reducer

Accessors

Methods

[asyncDispose] [asyncIterator] close dispatch getState iterator start subscribe

Constructors

constructor

new ReduxStore<State, Event, Action>(reducer, initialState, bus?): ReduxStore<State, Event, Action>
Type Parameters
- State
- Event
- Action = Event
Parameters
- reducer: MessageReduceHandler<State, Event, object>
  Reducer function.
- initialState: State
  Initial state.
- bus: MessageBus<Action, Event, object> = ...
  MessageBus to use.
Returns ReduxStore<State, Event, Action>
Overrides ReduceStore.constructor
- Defined in cqrs/src/preset/redux.ts:11

Properties

`Protected` `Readonly` bus

bus: MessageBus<Action, Event, object> = ...

MessageBus to use.

`Protected` `Readonly` eventBus

eventBus: MessageBus<State, State, object> = ...

Output event bus.

`Protected` `Readonly` reducer

reducer: MessageReducer<State, Event, object>

Reducer to use.

Accessors

started

get started(): boolean
Returns if this has started.

Returns boolean
Implementation of ReactiveStore.started
Inherited from ReduceStore.started
- Defined in cqrs/src/preset/store.ts:40

Methods

[asyncDispose]

[asyncDispose](): Promise<void>
Returns Promise<void>
Inherited from ReduceStore.[asyncDispose]
- Defined in commons/dist/lifecycle/closeable.d.ts:15

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<State>
Returns AsyncIterableIterator<State>
Inherited from ReduceStore.[asyncIterator]
- Defined in cqrs/src/preset/store.ts:64

close

close(options?): MaybePromise<void>
Closes this object and releases any system resource associated with it.
Parameters
- Optional options: AbortOptions
Returns MaybePromise<void>
Implementation of ReactiveStore.close
Inherited from ReduceStore.close
- Defined in cqrs/src/preset/store.ts:48

dispatch

dispatch(action, options?): MaybePromise<void>
Dispatches a message.
Parameters
- action: Action
- Optional options: AbortOptions
Returns MaybePromise<void>
Implementation of MessageDispatcher.dispatch
- Defined in cqrs/src/preset/redux.ts:23

getState

getState(): State
Returns the current state.

Returns State
Implementation of ReactiveStore.getState
Inherited from ReduceStore.getState
- Defined in cqrs/src/preset/store.ts:52

iterator

iterator(options?): AsyncIterableIterator<State>
Returns an async iterator that yields the latest state on change.
Parameters
- Optional options: AsyncSubscriberOptions
Returns AsyncIterableIterator<State>
Implementation of ReactiveStore.iterator
Inherited from ReduceStore.iterator
- Defined in cqrs/src/preset/store.ts:60

start

start(options?): MaybePromise<void>
Starts this component.
Parameters
- Optional options: AbortOptions
Returns MaybePromise<void>
Implementation of ReactiveStore.start
Inherited from ReduceStore.start
- Defined in cqrs/src/preset/store.ts:44

subscribe

subscribe(consumer): MaybePromise<Unsubscribe>
Subscribes to new messages and returns a handle to unsubscribe.
Parameters
- consumer: MessageHandler<State>
Returns MaybePromise<Unsubscribe>
Implementation of ReactiveStore.subscribe
Inherited from ReduceStore.subscribe
- Defined in cqrs/src/preset/store.ts:56

Generated using TypeDoc