DirtyTreeMap Interface
A map-like interface for tracking the status of nodes that have been tracked for changes.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
Signature
export interface DirtyTreeMap
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| get(node) | Alpha | DirtyTreeStatus | undefined | |
| set(node, status) | Alpha | void |
Method Details
get
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
get(node: TreeNode): DirtyTreeStatus | undefined;
Parameters
| Parameter | Type | Description |
|---|---|---|
| node | TreeNode |
Returns
Return type: DirtyTreeStatus | undefined
set
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
set(node: TreeNode, status: DirtyTreeStatus): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| node | TreeNode | |
| status | DirtyTreeStatus |