Packages > @fluidframework/merge-tree > IMergeTreeTextHelper

IMergeTreeTextHelper Interface

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

This functionality was not meant to be exported and will be removed in a future release

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 IMergeTreeTextHelper

Methods

Method Alerts Return Type Description
getText(refSeq, clientId, placeholder, start, end) Alpha string

Method Details

getText

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

getText(refSeq: number, clientId: number, placeholder: string, start?: number, end?: number): string;

Parameters

Parameter Modifiers Type Description
refSeq number
clientId number
placeholder string
start optional number
end optional number

Returns

Return type: string