Packages > @fluidframework/merge-tree > IRemovalInfo

IRemovalInfo Interface

Contains removal information associated to an ISegment .

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 IRemovalInfo

Properties

Property Alerts Modifiers Type Description
localRemovedSeq Alpha optional number Local seq at which this segment was removed, if the removal is yet-to-be acked.
removedClientIds Alpha number[] List of client IDs that have removed this segment. The client that actually removed the segment (i.e. whose removal op was sequenced first) is stored as the first client in this list. Other clients in the list have all issued concurrent ops to remove the segment.
removedSeq Alpha number Seq at which this segment was removed.

Property Details

localRemovedSeq

Local seq at which this segment was removed, if the removal is yet-to-be acked.

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

localRemovedSeq?: number;

Type: number

removedClientIds

List of client IDs that have removed this segment. The client that actually removed the segment (i.e. whose removal op was sequenced first) is stored as the first client in this list. Other clients in the list have all issued concurrent ops to remove the 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

removedClientIds: number[];

Type: number[]

Remarks

When this list has length > 1, this is referred to as the “overlapping remove” case.

removedSeq

Seq at which this segment was removed.

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

removedSeq: number;

Type: number