TreeIndex Interface
An index allows lookup content from a tree using keys.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
/** @sealed */
export interface TreeIndex<TKey, TValue> extends ReadonlyMap<TKey, TValue>
Extends: ReadonlyMap<TKey, TValue>
Type Parameters
| Parameter | Description |
|---|---|
| TKey | |
| TValue |
Remarks
The index will be kept up to date with the TreeBranchAlpha it is associated with. Keeping an index up to date incurs overhead. Therefore, indexes should only be created when needed and disposed when no longer needed.
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| dispose() | Alpha | void | Disposes the index such that it can no longer be used and receives no updates for changes in the tree. |
Method Details
dispose
Disposes the index such that it can no longer be used and receives no updates for changes in the tree.
For more information about our API support guarantees, see here.
Signature
dispose(): void;
Remarks
An index may not be used after it is disposed.