Class ReduceStore<State, Event, HandlerOpts>

A ReactiveStore that is updated by a reducer function.

Type Parameters

State
Event
HandlerOpts = object

Hierarchy

AsyncDisposableCloseable
- ReduceStore
  - ReduxStore

Implements

ReactiveStore<State>
AsyncDisposable
AsyncIterable<State>

Index

Constructors

Properties

eventBus reducer

Accessors

Methods

[asyncDispose] [asyncIterator] close getState iterator start subscribe

Constructors

constructor

new ReduceStore<State, Event, HandlerOpts>(reducer, initialState, subscription, eventBus?): ReduceStore<State, Event, HandlerOpts>
Type Parameters
- State
- Event
- HandlerOpts = object
Parameters
- reducer: MessageReduceHandler<State, Event, HandlerOpts>
  Reducer function.
- initialState: State
  Initial state.
- subscription: MessageSubscription<Event, HandlerOpts>
  Event subscription to use.
- eventBus: MessageBus<State, State, object> = ...
  Output event bus.
Returns ReduceStore<State, Event, HandlerOpts>
Overrides AsyncDisposableCloseable.constructor
- Defined in cqrs/src/preset/store.ts:25

Properties

`Protected` `Readonly` eventBus

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

Output event bus.

`Protected` `Readonly` reducer

reducer: MessageReducer<State, Event, HandlerOpts>

Reducer to use.

Accessors

started

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

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

Methods

[asyncDispose]

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

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<State>
Returns AsyncIterableIterator<State>
Implementation of AsyncIterable.[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
Overrides AsyncDisposableCloseable.close
- Defined in cqrs/src/preset/store.ts:48

getState

getState(): State
Returns the current state.

Returns State
Implementation of ReactiveStore.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
- 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
- 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
- Defined in cqrs/src/preset/store.ts:56

Generated using TypeDoc