Skip to main content

NodeChangedDataDelta Interface

Data included for nodeChanged when the node is an array node.

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 NodeChangedDataDelta

Properties

PropertyAlertsModifiersTypeDescription
deltaAlphareadonlyreadonly ArrayNodeDeltaOp[] | undefinedThe sequential operations describing what changed in the array node.

Property Details

delta

The sequential operations describing what changed in the array node.

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 ArrayNodeDeltaOp[] | undefined;

Type: readonly ArrayNodeDeltaOp[] | undefined

Remarks

The value may be undefined in two cases: - The node was created locally and has not yet been inserted into a document tree (a known temporary limitation, tracked in AB#63261). - 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 ArrayNodeDeltaOp for op semantics.