Class DynArrayReducer<T>

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

Type Parameters

T

Hierarchy

DynArrayReducer (View Summary)
- TrieSearchQuery

Index

Constructors

Accessors

data derived destroyed filters index length reversed sort

Methods

[iterator] destroy initialize setData subscribe

Constructors

constructor

new DynArrayReducer<T>(
data?: Iterable<T, any, any> | DynArrayData<T>,
): DynArrayReducer<T>
Initializes DynArrayReducer. 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
- T
Parameters
- Optionaldata: Iterable<T, any, any> | DynArrayData<T>
  Data iterable to store if array or copy otherwise.
Returns DynArrayReducer<T>

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

get derived(): DynDerivedAPI<T[], number, T>
Returns DynDerivedAPI<T[], number, T>
Derived public API.

destroyed

get destroyed(): boolean
Returns boolean
Returns whether this instance is destroyed.

filters

get filters(): DynAdapterFilters<T>
Returns DynAdapterFilters<T>
The filters adapter.

index

get index(): DynIndexerAPI<number, T>
Returns DynIndexerAPI<number, T>
Returns the Indexer public API.

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: boolean): void
Sets reversed state and notifies subscribers.
Parameters
- reversed: boolean
  New reversed state.
Returns void

sort

get sort(): DynAdapterSort<T>
Returns DynAdapterSort<T>
The sort adapter.

Methods

[iterator]

"[iterator]"(): IterableIterator<T, any, any>
Provides an iterator for data stored in DynArrayReducer.

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

Yields

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

subscribe

subscribe(handler: (value: DynArrayReducer<T>) => void): () => void
Add a subscriber to this DynArrayReducer instance.
Parameters
- handler: (value: DynArrayReducer<T>) => void
  Callback function that is invoked on update / changes. Receives this reference.
Returns () => void
Unsubscribe function.