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

DynArrayReducer<T>
- TrieSearchQuery (View Summary)

Index

Constructors

constructor

new TrieSearchQuery<T extends object>(
trieSearch: TrieSearch<T>,
options?: TrieSearchQueryOptions<T>,
): TrieSearchQuery<T>
Type Parameters
- T extends object
Parameters
- trieSearch: TrieSearch<T>
  The associated TrieSearch instance.
- Optionaloptions: TrieSearchQueryOptions<T>
  Optional query settings.
Returns TrieSearchQuery<T>

Overrides DynArrayReducer.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.

Inherited from DynArrayReducer.data

derived

get derived(): DynReducer.API.DerivedList<T>

Returns DynReducer.API.DerivedList<T>
Derived public API.

Inherited from DynArrayReducer.derived

destroyed

get destroyed(): boolean

Returns boolean
Returns whether this instance is destroyed.

Inherited from DynArrayReducer.destroyed

filters

get filters(): Filters<T>

Returns Filters<T>
The filters adapter.

Inherited from DynArrayReducer.filters

index

get index(): Index<number>

Returns Index<number>
Returns the Indexer public API; is also iterable.

Inherited from DynArrayReducer.index

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.

Inherited from DynArrayReducer.length

limit

get limit(): Writable<number>

Returns Writable<number>
The writable store controlling the search results limit.

query

get query(): Writable<string | Iterable<string, any, any>>

Returns Writable<string | Iterable<string, any, any>>
The writable store controlling the search query.

reversed

get reversed(): boolean

Returns boolean
Returns current reversed state.

Inherited from DynArrayReducer.reversed
set reversed(reversed: boolean): void
Sets reversed state and notifies subscribers.
Parameters
- reversed: boolean
  New reversed state.
Returns void

Inherited from DynArrayReducer.reversed

sort

get sort(): DynReducer.API.Sort<T>

Returns DynReducer.API.Sort<T>
The sort adapter.

Inherited from DynArrayReducer.sort

trieReducer

get trieReducer(): TrieSearchReducer<T>

Returns TrieSearchReducer<T>
Any associated TrieSearch reducer function.
set trieReducer(trieReducer: TrieSearchReducer<T>): void
Parameters
- trieReducer: TrieSearchReducer<T>
  A new trie reducer function.
Returns void

trieSearch

get trieSearch(): TrieSearch<T>

Returns TrieSearch<T>
The associated TrieSearch instance; can be undefined.

Methods

[iterator]

"[iterator]"(): IterableIterator<T>

Provides an iterator for data stored in DynArrayReducer.

Returns IterableIterator<T>
Iterator for data stored in DynArrayReducer.

Inherited from DynArrayReducer.[iterator]

destroy

destroy(): void

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

Returns void

Overrides DynArrayReducer.destroy

`Protected`initialize

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
- OptionaloptionsRest: { [key: string]: any }
  Any additional custom options passed beyond DynReducer.Options.Common.
Returns void

Inherited from DynArrayReducer.initialize

setData

setData(data: T[] | Iterable<T, any, any>, 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, any, any>
  New data to set to internal data.
- Optionalreplace: boolean
  New data to set to internal data.
Returns void

Inherited from DynArrayReducer.setData

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.

Inherited from DynArrayReducer.subscribe

Class TrieSearchQuery<T>

Type Parameters

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TrieSearchQuery<T>

Accessors

data

Returns T[]

derived

Returns DynReducer.API.DerivedList<T>

destroyed

Returns boolean

filters

Returns Filters<T>

index

Returns Index<number>

isDestroyed

Returns boolean

length

Returns number

limit

Returns Writable<number>

query

Returns Writable<string | Iterable<string, any, any>>

reversed

Returns boolean

Parameters

Returns void

sort

Returns DynReducer.API.Sort<T>

trieReducer

Returns TrieSearchReducer<T>

Parameters

Returns void

trieSearch

Returns TrieSearch<T>

Methods

[iterator]

Returns IterableIterator<T>

destroy

Returns void

Protectedinitialize

Parameters

Returns void

setData

Parameters

Returns void

subscribe

Parameters

Returns () => void

Settings

On This Page

`Protected`initialize