Skip to main content

NodeChangedDataTreeDelta Interface

Data carried by the treeChanged event for array nodes.

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.

Sealed

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 NodeChangedDataTreeDelta

Remarks

Extends NodeChangedDataDelta: the retain ops in the delta additionally carry a subtreeChanged flag indicating whether any descendant of the retained element changed.

Properties

PropertyAlertsModifiersTypeDescription
deltaAlphareadonlyreadonly ArrayNodeTreeChangedDeltaOp[] | undefinedThe sequential operations describing what changed in the array node, including subtree-change information on retain ops.

Property Details

delta

The sequential operations describing what changed in the array node, including subtree-change information on retain ops.

This API is provided as an alpha preview and may change without notice.

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

Signature

readonly delta: readonly ArrayNodeTreeChangedDeltaOp[] | undefined;

Type: readonly ArrayNodeTreeChangedDeltaOp[] | undefined

Remarks

The value may be undefined when the document was updated in a way that required multiple internal change passes in a single operation (for example, a data change combined with a schema upgrade).

See ArrayNodeTreeChangedDeltaOp for op semantics.