Class TrieSearchQuery<T>

Provides a reactive query interface to TrieSearch in addition to dynamic filtering / sorting of search results.

Type Parameters

  • T extends object
Hierarchy

Constructors

constructor

Accessors

data derived destroyed filters index isDestroyed length limit query reversed sort trieReducer trieSearch

Methods

[iterator] destroy initialize setData subscribe

Constructors

constructor

Accessors

data

  • get data(): T[]

  • 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 DynArrayReducer.index with true to recalculate the index and notify all subscribers.

    Returns T[]

    The internal data.

derived

destroyed

  • get destroyed(): boolean

  • Returns boolean

    Returns whether this instance is destroyed.

filters

index

  • get index(): Index<number>

  • Returns Index<number>

    Returns the Indexer public API; is also iterable.

isDestroyed

  • get isDestroyed(): boolean

  • Returns boolean

    The current destroyed state of this query instance.

length

  • get length(): number

  • Returns number

    Returns the main data items or indexed items length.

limit

  • get limit(): Writable<number>

  • Returns Writable<number>

    The writable store controlling the search results limit.

query

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

trieReducer

trieSearch

Methods

[iterator]

destroy

  • destroy(): void

  • Destroys and disconnects this query from the local stores and any associated TrieSearch instance.

    Returns void

Protectedinitialize

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

    Provides a callback for custom reducers to initialize any data / custom configuration. Depending on the consumer of dynamic-reducer this may be utilized allowing child classes to avoid implementing the constructor.

    Parameters

    Returns void

setData

  • setData(data: T[] | Iterable<T>, replace?: boolean): 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: T[] | Iterable<T>

      New data to set to internal data.

    • Optionalreplace: boolean

      New data to set to internal data.

    Returns void

subscribe

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

  • Add a subscriber to this DynArrayReducer instance.

    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

Constructors
Accessors
Methods