InsertDiff Interface
An object that describes the insertion of a new node into 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 InsertDiff extends DiffBase
Extends: DiffBase
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| nodeContent | Alpha |
readonly |
unknown | The content of the newly inserted node. |
| nodePath | Alpha |
readonly |
NodePath | The path from the root node to the newly inserted node. The last value in the path will be the newly inserted node. If the newly inserted node is a primitive value, the last value in the path will be the parent array node. |
| type | Alpha |
readonly |
"insert" |
Property Details
nodeContent
The content of the newly inserted 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 nodeContent: unknown;
Type: unknown
nodePath
The path from the root node to the newly inserted node. The last value in the path will be the newly inserted node. If the newly inserted node is a primitive value, the last value in the path will be the parent 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 nodePath: NodePath;
Type: NodePath
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: "insert";
Type: "insert"