IMergeTreeObliterateMsg Interface

This API is deprecated and will be removed in a future release.

We no longer intend to support this functionality and it will be removed in a future release. There is no replacement for this functionality.

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

Extends: IMergeTreeDelta

Properties

Property	Alerts	Modifiers	Type	Description
pos1	Beta	optional	number
pos2	Beta	optional	number
relativePos1	Beta	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	Beta	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	Beta		typeof MergeTreeDeltaType.OBLITERATE

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?: number;

Type: number

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?: number;

Type: number

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;

Type: typeof MergeTreeDeltaType.OBLITERATE