IMergeTreeSegmentDelta Interface
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/merge-tree/legacy.
For more information about our API support guarantees, see here.
Signature
export interface IMergeTreeSegmentDelta
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| propertyDeltas | Alpha |
optional |
PropertySet | A property set containing changes to properties on this segment. |
| segment | Alpha |
ISegment | The segment this delta affected. |
Property Details
propertyDeltas
A property set containing changes to properties on this segment.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here.
Signature
propertyDeltas?: PropertySet;
Type: PropertySet
Remarks
- Deleting a property is represented using
nullas the value.
Example
An annotation change which deleted the property "foo" and set "bar" to 5 would be represented as: { foo: null, bar: 5 }.
segment
The segment this delta affected.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here.
Signature
segment: ISegment;
Type: ISegment