Class DynMapReducer<K, T>

    Provides a managed Map with non-destructive reducing / filtering / sorting capabilities with subscription / Svelte store support.

    Template: K,

    T

    Type Parameters

    • K
    • T

    Constructors

    constructor

    Accessors

    data derived destroyed filters index length reversed sort

    Methods

    #updateSubscribers [iterator] destroy initialize setData subscribe

    Properties

    #derived #derivedPublicAPI #destroyed #filters #filtersData #index #indexPublicAPI #map #reversed #sort #sortData #subscriptions

    Constructors

    constructor

    • new DynMapReducer<K, T>(data?): DynMapReducer<K, T>

    • Initializes DynMapReducer. Any iterable is supported for initial data. Take note that if data is an array it will be used as the host array and not copied. All non-array iterables otherwise create a new array / copy.

      Type Parameters

      • K
      • T

      Parameters

      • Optional data: Map<K, T> | DynMapData<K, T>

        Data iterable to store if array or copy otherwise.

      Returns DynMapReducer<K, T>

    Accessors

    data

    • get data(): Map<K, T>

    • Returns the internal data of this instance. Be careful!

      Note: When a map is set as data then that map is used as the internal data. If any changes are performed to the data externally do invoke update via DynMapReducer.index with true to recalculate the index and notify all subscribers.

      Returns Map<K, T>

      The internal data.

    derived

    destroyed

    filters

    index

    length

    • get length(): number

    • Gets the main data / items length.

      Returns number

      Main data / items length.

    reversed

    • get reversed(): boolean

    • Gets current reversed state.

      Returns boolean

      Reversed state.

    • set reversed(reversed): void

    • Sets reversed state and notifies subscribers.

      Parameters

      • reversed: boolean

        New reversed state.

      Returns void

    sort

    Methods

    Private #updateSubscribers

    [iterator]

    destroy

    • destroy(): void

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

      Returns void

    Protected initialize

    • initialize(): void
    • Protected

      Provides a callback for custom reducers to initialize any data / custom configuration. This allows child classes to avoid implementing the constructor.

      Returns void

    setData

    • setData(data, replace?): void

    • Removes internal data and pushes new data. This does not destroy any initial array set to internal data unless replace is set to true.

      Parameters

      • data: Map<K, T>

        New data to set to internal data.

      • Optional replace: boolean = false

        New data to set to internal data.

      Returns void

    subscribe

    • subscribe(handler): (() => void)

    • Add a subscriber to this DynMapReducer instance.

      Parameters

      • handler: ((value) => void)

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

      Returns (() => void)

      Unsubscribe function.

        • (): void

        • Returns void

    Properties

    Private Readonly #derived

    #derived: AdapterDerived<Map<K, T>, K, T>

    Private Readonly #derivedPublicAPI

    #derivedPublicAPI: DerivedAPI<Map<K, T>, K, T>

    Private #destroyed

    #destroyed: boolean = false

    Private Readonly #filters

    #filters: AdapterFilters<T>

    Private Readonly #filtersData

    #filtersData: {
        filters: DynDataFilter<T>[];
    } = ...

    Type declaration

    Private Readonly #index

    #index: MapIndexer<K, T>

    Private Readonly #indexPublicAPI

    #indexPublicAPI: IndexerAPI<K, T>

    Private #map

    #map: DynDataHost<Map<K, T>> = ...

    Private #reversed

    #reversed: boolean = false

    Private Readonly #sort

    #sort: AdapterSort<T>

    Private #sortData

    #sortData: {
        compareFn: DynCompareFn<T>;
    } = ...

    Type declaration

    Private #subscriptions

    #subscriptions: Function[] = []

    Settings

    Member Visibility

    Theme

    On This Page

    constructordataderiveddestroyedfiltersindexlengthreversedsort#updateSubscribers[iterator]destroyinitializesetDatasubscribe#derived#derivedPublicAPI#destroyed#filters#filtersData#index#indexPublicAPI#map#reversed#sort#sortData#subscriptions