Interface IDynDerivedReducer<D, K, T>

    Defines the interface for a derived reducer.

    interface IDynDerivedReducer<D, K, T> {
        get data(): D;
        get derived(): IDynDerivedAPI<D, K, T>;
        get destroyed(): boolean;
        get filters(): IDynAdapterFilters<T>;
        get index(): IDynIndexerAPI<K, T>;
        get length(): number;
        reversed: boolean;
        get sort(): IDynAdapterSort<T>;
        destroy(): void;
        subscribe(handler): (() => void);
    }

    Type Parameters

    • D
    • K
    • T

    Implemented by

    Accessors

    data derived destroyed filters index length reversed sort

    Methods

    destroy subscribe

    Accessors

    data

    • get data(): D

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

      Note: if an array is set as initial data then that array is used as the internal data. If any changes are performed to the data externally do invoke update via IDynDerivedReducer.index with true to recalculate the index and notify all subscribers.

      Returns D

      The internal data.

    derived

    destroyed

    • get destroyed(): boolean

    • Returns whether this derived reducer is destroyed.

      Returns boolean

    filters

    index

    length

    • get length(): number

    • Returns number

      Main data / items length or indexed length.

    reversed

    • get reversed(): boolean

    • Returns boolean

      Gets current reversed state.

    • set reversed(reversed): void

    • Sets reversed state and notifies subscribers.

      Parameters

      • reversed: boolean

        New reversed state.

      Returns void

    sort

    Methods

    destroy

    • destroy(): void

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

      Returns void

    subscribe

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

    • Subscribe to this IDerivedReducer.

      Parameters

      • handler: ((value) => void)

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

      Returns (() => void)

      Unsubscribe function.

        • (): void

        • Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    dataderiveddestroyedfiltersindexlengthreversedsortdestroysubscribe