MoveRangeDiff Interface
An object that describes the movement of a range of nodes 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 MoveRangeDiff 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-range" | The type of movement being performed. |
| nodeContents | Alpha | readonly | unknown[] | The content of each of the nodes being moved from the source array node to the destination array node. |
| sourceNodePaths | Alpha | readonly | NodePath[] | The paths to each node being moved from the source array node. |
| 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-range";
Type: "move-range"
nodeContents
The content of each of the nodes being moved from the source array node to the destination array node.
For more information about our API support guarantees, see here.
Signature
readonly nodeContents: unknown[];
Type: unknown[]
sourceNodePaths
The paths to each node being moved from the source array node.
For more information about our API support guarantees, see here.
Signature
readonly sourceNodePaths: NodePath[];
Type: NodePath[]
type
For more information about our API support guarantees, see here.
Signature
readonly type: "move";
Type: "move"