Skip to main content

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 fluid-framework/alpha.

For more information about our API support guarantees, see here.

Signature

export interface DirtyTreeMap

Methods

MethodAlertsReturn TypeDescription
get(node)AlphaDirtyTreeStatus | undefined
set(node, status)Alphavoid

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

ParameterTypeDescription
nodeTreeNode

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

ParameterTypeDescription
nodeTreeNode
statusDirtyTreeStatus