MoveSingleDiff Interface
An object that describes the movement of a single node from one array node to another array node.
To use, import via @fluidframework/ai-collab/alpha.
For more information about our API support guarantees, see here.
Signature
export interface MoveSingleDiff extends DiffBase
Extends: DiffBase
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| destinationNodePath | Alpha | readonly | NodePath | The path from the root of the tree to the destination array node. |
| moveType | Alpha | readonly | "move-single" | The type of movement being performed. |
| nodeContent | Alpha | readonly | unknown | The content of the node being moved from the source array node to the destination array node. |
| sourceNodePath | Alpha | readonly | NodePath | The path from the root of the tree to the source node. The last value in the path will be the node being moved |
| type | Alpha | readonly | "move" |
Property Details
destinationNodePath
The path from the root of the tree to the destination array node.
For more information about our API support guarantees, see here.
Signature
readonly destinationNodePath: NodePath;
Type: NodePath
moveType
The type of movement being performed.
For more information about our API support guarantees, see here.
Signature
readonly moveType: "move-single";
Type: "move-single"
nodeContent
The content of the node being moved from the source array node to the destination array node.
For more information about our API support guarantees, see here.
Signature
readonly nodeContent: unknown;
Type: unknown
sourceNodePath
The path from the root of the tree to the source node. The last value in the path will be the node being moved
For more information about our API support guarantees, see here.
Signature
readonly sourceNodePath: NodePath;
Type: NodePath
type
For more information about our API support guarantees, see here.
Signature
readonly type: "move";
Type: "move"