TreeIndex Interface
A index where values are keyed on TreeIndexKeys.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
Signature
export interface TreeIndex<TKey extends TreeIndexKey, TValue> extends ReadonlyMap<TKey, TValue>
Extends: ReadonlyMap<TKey, TValue>
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| TKey | TreeIndexKey | |
| TValue |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| dispose() | Alpha |
void | Disposes the index such that it can no longer be used and receives no updates from the forest |
Method Details
dispose
Disposes the index such that it can no longer be used and receives no updates from the forest
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
dispose(): void;