Class DynMapReducerDerived<K, T>

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.

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.

Implements

Accessors

derived destroyed filters index length reversed sort

Methods

[iterator] destroy initialize subscribe

Accessors

derived

destroyed

  • get destroyed(): boolean

  • Returns boolean

    Returns whether this derived reducer is destroyed.

filters

index

  • get index(): Index<K>

  • Returns Index<K>

    Returns the Indexer public API; is also iterable.

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

Methods

[iterator]

destroy

  • destroy(): void

  • Removes all derived reducers, subscriptions, and cleans up all resources.

    Returns void

Protectedinitialize

  • initialize(optionsRest?: { [key: string]: any }): void
  • Protected

    Provides 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(handler: (value: this) => void): () => void

  • Subscribe to this DerivedMapReducer.

    Parameters

    • handler: (value: this) => void

      Callback function that is invoked on update / changes. Receives this reference.

    Returns () => void

    Unsubscribe function.

Settings

Member Visibility

On This Page

Accessors
Methods