ArrayRangeRemoveDiff Interface

An object that describes the removal of a range of nodes 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 ArrayRangeRemoveDiff extends DiffBase

Extends: DiffBase

Properties

Property	Alerts	Modifiers	Type	Description
nodeContents	Alpha	readonly	unknown[]	The content of each of the nodes being removed from the array node.
nodePaths	Alpha	readonly	NodePath[]	The paths to each node being removed from the array node.
removalType	Alpha	readonly	"remove-array-range"	The type of removal being performed.
type	Alpha	readonly	"remove"

Property Details

nodeContents

The content of each of the nodes 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 nodeContents: unknown[];

Type: unknown[]

nodePaths

The paths to each 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 nodePaths: 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-range";

Type: "remove-array-range"

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"