Interface IDynDerivedReducer<D, K, T>

Defines the interface for all derived reducers.

interface IDynDerivedReducer<D, K, T> {
    get data(): D;
    get derived(): DerivedAPI<D, K, T>;
    get destroyed(): boolean;
    get filters(): AdapterFilters<T>;
    get index(): IndexerAPI<K, T>;
    get length(): number;
    reversed: boolean;
    get sort(): AdapterSort<T>;
    destroy(): any;
    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 index.update with true to recalculate the index and notify all subscribers.

    Returns D

    The internal data.

derived

  • get derived(): DerivedAPI<D, K, T>

  • Returns DerivedAPI<D, K, T>

    Derived public API.

destroyed

  • get destroyed(): boolean

  • Returns whether this derived reducer is destroyed.

    Returns boolean

filters

  • get filters(): AdapterFilters<T>

  • Returns AdapterFilters<T>

    The filters adapter.

index

  • get index(): IndexerAPI<K, T>

  • Returns IndexerAPI<K, T>

    Returns the Indexer public API.

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

  • get sort(): AdapterSort<T>

  • Returns AdapterSort<T>

    The sort adapter.

Methods

destroy

  • destroy(): any

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

    Returns any

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