Class DynMapReducerDerived<K, T>

Provides the base implementation derived reducer for arrays / DynArrayReducer.

Type Parameters

K
T

Implements

IDynDerivedReducer<Map<K, T>, K, T>

Index

Constructors

Accessors

data derived destroyed filters index length reversed sort

Methods

[iterator] destroy initialize subscribe

Constructors

constructor

new DynMapReducerDerived<K, T>(map, parentIndex, options): DynMapReducerDerived<K, T>
Type Parameters
- K
- T
Parameters
- map: DynDataHost<Map<K, T>>
  Data host Map.
- parentIndex: IndexerAPI<K, T>
  Parent indexer.
- options: DynDataOptions<T>
  Any filters and sort functions to apply.
Returns DynMapReducerDerived<K, T>

Accessors

data

get data(): Map<K, T>
Returns the internal data of this instance. Be careful!

Note: The returned map is the same map set by the main reducer. If any changes are performed to the data externally do invoke IndexerAPI.update with true to recalculate the index and notify all subscribers.

Returns Map<K, T>
The internal data.

Implementation of IDynDerivedReducer.data

derived

get derived(): DerivedAPI<Map<K, T>, K, T>
Returns DerivedAPI<Map<K, T>, K, T>
Derived public API.

Implementation of IDynDerivedReducer.derived

destroyed

get destroyed(): boolean
Returns whether this derived reducer is destroyed.

Returns boolean
Implementation of IDynDerivedReducer.destroyed

filters

get filters(): AdapterFilters<T>
Returns AdapterFilters<T>
The filters adapter.

Implementation of IDynDerivedReducer.filters

index

get index(): IndexerAPI<K, T>
Returns the Indexer public API.

Returns IndexerAPI<K, T>
Indexer API - is also iterable.

Implementation of IDynDerivedReducer.index

length

get length(): number
Returns number
Main data / items length or indexed length.

Implementation of IDynDerivedReducer.length

reversed

get reversed(): boolean
Returns boolean
Gets current reversed state.

Implementation of IDynDerivedReducer.reversed
set reversed(reversed): void
Sets reversed state and notifies subscribers.
Parameters
- reversed: boolean
  New reversed state.
Returns void
Implementation of IDynDerivedReducer.reversed

sort

get sort(): AdapterSort<T>
Returns AdapterSort<T>
The sort adapter.

Implementation of IDynDerivedReducer.sort

Methods

[iterator]

[iterator](): IterableIterator<T>
Provides an iterator for data stored in DerivedMapReducer.

Returns IterableIterator<T>
Yields

destroy

destroy(): void
Removes all derived reducers, subscriptions, and cleans up all resources.

Returns void
Implementation of IDynDerivedReducer.destroy

`Protected` initialize

initialize(): void
Protected
Provides a callback for custom derived reducers to initialize any data / custom configuration. This allows child classes to avoid implementing the constructor.

Returns void

subscribe

subscribe(handler): (() => void)
Subscribe to this DerivedMapReducer.
Parameters
- handler: ((value) => void)
  Callback function that is invoked on update / changes. Receives this reference.
  - - (value): void
    - Parameters
      value: DynMapReducerDerived<K, T>
      Returns void
Returns (() => void)
Unsubscribe function.
- - (): void
  - Returns void
Implementation of IDynDerivedReducer.subscribe