Interface DerivedMap<K, T>

Defines the common interface for a derived map reducer.

interface DerivedMap<K = unknown, T = unknown> {
    get derived(): DynReducer.API.DerivedMap<K, T>;
    get destroyed(): boolean;
    get filters(): DynReducer.API.Filters<T>;
    get index(): Index<K>;
    get length(): number;
    get reversed(): boolean;
    set reversed(reversed: boolean): void;
    get sort(): DynReducer.API.Sort<T>;
    "[iterator]"(): IterableIterator<T>;
    destroy(): void;
    subscribe(
        handler: (value: DynReducer.DerivedMap<K, T>) => void,
    ): () => void;
}

Type Parameters

K = unknown
unknown - Key type. Defaults to unknown to enforce type safety when no type is specified.
T = unknown
unknown - Type of data. Defaults to unknown to enforce type safety when no type is specified.

Implemented by

DynMapReducerDerived

Index

Accessors

derived destroyed filters index length reversed sort

Methods

[iterator] destroy subscribe

Accessors

derived

get derived(): DynReducer.API.DerivedMap<K, T>
Returns DynReducer.API.DerivedMap<K, T>
Derived public API.

destroyed

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

filters

get filters(): DynReducer.API.Filters<T>
Returns DynReducer.API.Filters<T>
The filters adapter.

index

get index(): Index<K>
Returns Index<K>
Returns the Indexer public API.

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

sort

get sort(): DynReducer.API.Sort<T>
Returns DynReducer.API.Sort<T>
The sort adapter.

Methods

[iterator]

"[iterator]"(): IterableIterator<T>
Returns IterableIterator<T>
Provides an iterator for data stored in the derived reducer.

destroy

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

Returns void

subscribe(handler: (value: DynReducer.DerivedMap<K, T>) => void): () => void
Add a subscriber to this DynMapReducer instance.
Parameters
- handler: (value: DynReducer.DerivedMap<K, T>) => void
  Callback function that is invoked on update / changes. Receives this reference.
Returns () => void
Unsubscribe function.