Interface Index<K>

Provides the public API for accessing the index API.

This class forms the public API which is accessible from the .index getter in the main reducer implementation.

const dynArray = new DynArrayReducer([...]);
dynArray.index.active;
dynArray.index.hash;
dynArray.index.length;
dynArray.index.update(...);

interface Index<K> {
    get active(): boolean;
    get hash(): number;
    get length(): number;
    "[iterator]"(): IterableIterator<K>;
    update(force?: boolean): void;
}

Accessors

"[iterator]"(): IterableIterator<K>
Provides an iterator over the index array.

Returns IterableIterator<K>
Iterator for the index array.

update(force?: boolean): void
Manually invoke an update of the index.
Parameters
- Optionalforce: boolean
  Force update to any subscribers.
Returns void