ArraySingleRemoveDiff Interface

An object that describes the removal of a single node from an array node.

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 ArraySingleRemoveDiff extends DiffBase

Extends: DiffBase

Properties

Property	Alerts	Modifiers	Type	Description
nodeContent	Alpha	readonly	unknown	The content of the node being removed from the array node.
nodePath	Alpha	readonly	NodePath	The path from the root of the tree to the node being removed from the array node.
removalType	Alpha	readonly	"remove-array-single"	The type of removal being performed.
type	Alpha	readonly	"remove"

Property Details

nodeContent

The content of the node being removed from 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 nodeContent: unknown;

Type: unknown

nodePath

The path from the root of the tree to the node being removed from 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 nodePath: NodePath;

Type: NodePath

removalType

The type of removal being performed.

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 removalType: "remove-array-single";

Type: "remove-array-single"

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: "remove";

Type: "remove"