Skip to main content

IMergeTreeObliterateSidedMsg 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 IMergeTreeObliterateSidedMsg extends IMergeTreeDelta

Extends: IMergeTreeDelta

Properties​

Property Alerts Modifiers Type Description
pos1 Alpha { pos: number; before: boolean; }
pos2 Alpha { pos: number; before: boolean; }
relativePos1 Alpha optional never This field is currently unused, but we keep it around to make the union type of all merge-tree messages have the same fields
relativePos2 Alpha optional never This field is currently unused, but we keep it around to make the union type of all merge-tree messages have the same fields
type Alpha typeof MergeTreeDeltaType.OBLITERATE_SIDED

Property Details​

pos1​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

pos1: {
        pos: number;
        before: boolean;
    };

Type: { pos: number; before: boolean; }

pos2​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

pos2: {
        pos: number;
        before: boolean;
    };

Type: { pos: number; before: boolean; }

relativePos1​

This field is currently unused, but we keep it around to make the union type of all merge-tree messages have the same fields

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

relativePos1?: never;

Type: never

relativePos2​

This field is currently unused, but we keep it around to make the union type of all merge-tree messages have the same fields

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

relativePos2?: never;

Type: never

type​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

type: typeof MergeTreeDeltaType.OBLITERATE_SIDED;

Type: typeof MergeTreeDeltaType.OBLITERATE_SIDED