Class DynMapReducerDerived<K, T>
Type Parameters
- K = unknown
unknown- Key type. Defaults tounknownto enforce type safety when no type is specified. - T = unknown
unknown- Type of data. Defaults tounknownto enforce type safety when no type is specified.
Implements
Accessors
derived
Returns DynReducer.API.DerivedMap<K, T>
Derived public API.
destroyed
- get destroyed(): boolean
Returns boolean
Returns whether this derived reducer is destroyed.
filters
Returns DynReducer.API.Filters<T>
The filters adapter.
index
length
- get length(): number
Returns number
Returns the main data items or indexed items length.
reversed
- get reversed(): boolean
Returns boolean
Returns current reversed state.
- set reversed(reversed: boolean): void
Sets reversed state and notifies subscribers.
Parameters
- reversed: boolean
New reversed state.
Returns void
- reversed: boolean
sort
Returns DynReducer.API.Sort<T>
Returns the sort adapter.
Methods
[iterator]
Provides an iterator for data stored in DynMapReducerDerived.
Returns IterableIterator<T>
Iterator for data stored in DynMapReducerDerived.
destroy
Removes all derived reducers, subscriptions, and cleans up all resources.
Returns void
Protectedinitialize
ProtectedProvides a callback for custom derived reducers to initialize any data / custom configuration. This allows child classes to avoid implementing the constructor.
Parameters
OptionaloptionsRest: { [key: string]: any }Any additional custom options passed beyond DynDataOptions.
Returns void
subscribe
Subscribe to this DerivedMapReducer.
Parameters
- handler: (value: this) => void
Callback function that is invoked on update / changes. Receives
thisreference.
Returns () => void
Unsubscribe function.
- handler: (value: this) => void
Provides the base implementation derived reducer for Maps / DynMapReducer.
Note: That you should never directly create an instance of a derived reducer, but instead use the DynMapReducerDerived.initialize function to set up any initial state in a custom derived reducer.