ModifyDiff Interface

An object that describes the modification of an existing node on a tree.

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

To use, import via @fluidframework/ai-collab/alpha.

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

Signature

export interface ModifyDiff extends DiffBase

Extends: DiffBase

Properties

Property	Alerts	Modifiers	Type	Description
newValue	Alpha	readonly	unknown	The new value of the node.
nodePath	Alpha	readonly	NodePath	The path from the root node to the ndoe being modified.
oldValue	Alpha	readonly	unknown	The old value of the node.
type	Alpha	readonly	"modify"

Property Details

newValue

The new value of the 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 newValue: unknown;

Type: unknown

nodePath

The path from the root node to the ndoe being modified.

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 nodePath: NodePath;

Type: NodePath

oldValue

The old value of the 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 oldValue: unknown;

Type: unknown

type

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 type: "modify";

Type: "modify"