DifferenceRemove Interface
Represents a remove operation between two branches of a tree. Meaning that an attribute (a shared tree node) was identified as being deleted. When using object ids, removes are idenitified by an object with a given id no longer existing.
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 DifferenceRemove
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| objectId | Alpha |
optional |
string | number | undefined | |
| oldValue | Alpha |
unknown | ||
| path | Alpha |
ObjectPath | ||
| type | Alpha |
"REMOVE" |
Property Details
objectId
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
objectId?: string | number | undefined;
Type: string | number | undefined
oldValue
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
oldValue: unknown;
Type: unknown
path
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
path: ObjectPath;
Type: ObjectPath
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
type: "REMOVE";
Type: "REMOVE"