Skip to main content

DifferenceChange Interface

Represents a change operation between two branches of a tree. Meaning that an attribute (a shared tree node) was identified as being changed from one value to another.

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 DifferenceChange

Properties

Property Alerts Modifiers Type Description
objectId Alpha optional string | number | undefined
oldValue Alpha unknown
path Alpha ObjectPath
type Alpha "CHANGE"
value Alpha unknown

Property Details

objectId

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

objectId?: string | number | undefined;

Type: string | number | undefined

oldValue

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

oldValue: unknown;

Type: unknown

path

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

path: ObjectPath;

Type: ObjectPath

type

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

type: "CHANGE";

Type: "CHANGE"

value

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

value: unknown;

Type: unknown