IMergeTreeDeltaCallbackArgs Interface
Packages > @fluidframework/merge-tree > IMergeTreeDeltaCallbackArgs
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 IMergeTreeDeltaCallbackArgs<TOperationType extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationType>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TOperationType | MergeTreeDeltaOperationTypes | MergeTreeDeltaOperationType |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| deltaSegments | Alpha |
readonly |
IMergeTreeSegmentDelta[] |
A list of deltas describing actions taken on segments. Deltas are not guaranteed to be in any particular order. |
| operation | Alpha |
readonly |
TOperationType |
The type of operation that affected segments in the merge-tree. The affected segments can be accessed via deltaSegments. See MergeTreeDeltaOperationType and MergeTreeMaintenanceType for possible values. |
Property Details
deltaSegments
A list of deltas describing actions taken on segments.
Deltas are not guaranteed to be in any particular order.
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
readonly deltaSegments: IMergeTreeSegmentDelta[];
Type: IMergeTreeSegmentDelta []
operation
The type of operation that affected segments in the merge-tree. The affected segments can be accessed via deltaSegments .
See MergeTreeDeltaOperationType and MergeTreeMaintenanceType for possible values.
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
readonly operation: TOperationType;
Type: TOperationType