FormattedString

^{ref / parse-mode / FormattedString}

Represents the formatted string after parsing. This class provides a unified interface for working with formatted text that can be used as both message text and caption content in Telegram Bot API calls.

^Source

Implements

CaptionWithEntities, TextWithEntities, TextWithTextEntities, TitleWithTitleEntities, Stringable

Constructors

FormattedString(rawText: string, rawEntities?: MessageEntity[]);

Creates a new FormattedString instance.

^Source

Properties

rawEntities

rawEntities: MessageEntity[];

The entities backing this FormattedString.

^Source

rawText

rawText: string;

The plain text content

^Source

Methods

caption (getter)

get caption();

Gets the caption text. This is an alias for the raw text content. Used when this FormattedString is used as caption content.

^Source

text (getter)

get text();

Gets the plain text content. This is an alias for the raw text content. Used when this FormattedString is used as message text.

^Source

title (getter)

get title();

Gets the title. Alias for rawText. Used when this FormattedString is used as title.

^Source

text_entities (getter)

get text_entities();

Gets the text_entities. Alias for rawEntities. Used when this FormattedString is used as text with text_entities.

^Source

title_entities (getter)

get title_entities();

Gets the title_entities. Alias for rawEntities. Used when this FormattedString is used as title_entities.

^Source

caption_entities (getter)

get caption_entities();

Gets the caption entities. This is an alias for the raw entities. Used when this FormattedString is used as caption content.

^Source

entities (getter)

get entities();

Gets the message entities. This is an alias for the raw entities. Used when this FormattedString is used as message text.

^Source

toString

toString();

Returns the string representation of this FormattedString object

^Source

b

b();

Combines this FormattedString with a bold formatted string

^Source

bold

bold();

Combines this FormattedString with a bold formatted string

^Source

i

i();

Combines this FormattedString with an italic formatted string

^Source

italic

italic();

Combines this FormattedString with an italic formatted string

^Source

s

s();

Combines this FormattedString with a strikethrough formatted string

^Source

strikethrough

strikethrough();

Combines this FormattedString with a strikethrough formatted string

^Source

u

u();

Combines this FormattedString with an underline formatted string

^Source

underline

underline();

Combines this FormattedString with an underline formatted string

^Source

a

a();

Combines this FormattedString with a link formatted string

^Source

link

link();

Combines this FormattedString with a link formatted string

^Source

code

code();

Combines this FormattedString with a code formatted string

^Source

pre

pre();

Combines this FormattedString with a pre formatted string (code block)

^Source

spoiler

spoiler();

Combines this FormattedString with a spoiler formatted string

^Source

blockquote

blockquote();

Combines this FormattedString with a blockquote formatted string

^Source

expandableBlockquote

expandableBlockquote();

Combines this FormattedString with an expandable blockquote formatted string

^Source

mentionUser

mentionUser();

Combines this FormattedString with a user mention formatted string

^Source

customEmoji

customEmoji();

^Source

emoji

emoji();

Combines this FormattedString with an emoji formatted string using custom emoji

^Source

time

time();

Combines this FormattedString with a date_time formatted string

^Source

linkMessage

linkMessage();

Combines this FormattedString with a message link formatted string

^Source

plain

plain();

Combines this FormattedString with plain text

^Source

split

split();

Splits this FormattedString into an array of FormattedStrings using a separator

^Source

splitByText

splitByText();

Splits this FormattedString into an array of FormattedStrings using a separator, ignoring inequalities in rawEntities. Only uses rawText to determine if this is a valid position to split.

^Source

slice

slice();

Returns a copy of a portion of this FormattedString

^Source

_findMatches

_findMatches();

Protected method that finds pattern matches within this FormattedString.

^Source

find

find();

Finds the first occurrence of a FormattedString pattern within this FormattedString that matches both the raw text and raw entities exactly.

^Source

findAll

findAll();

Finds all occurrences of a FormattedString pattern within this FormattedString that match both the raw text and raw entities exactly.

^Source

replaceMatches

replaceMatches();

Protected method to replace matches at given offsets with a replacement.

^Source

replace

replace();

Returns a new FormattedString with the first occurrence of pattern replaced by replacement. Both the raw text and raw entities must match exactly for replacement to occur.

^Source

replaceAll

replaceAll();

Returns a new FormattedString with all occurrences of pattern replaced by replacement. Both the raw text and raw entities must match exactly for replacement to occur.

^Source

concat

concat();

Concatenates this FormattedString with one or more other FormattedStrings

^Source

startsWith

startsWith();

Checks whether this FormattedString starts with the specified pattern. Both the raw text and raw entities must match exactly.

^Source

endsWith

endsWith();

Checks whether this FormattedString ends with the specified pattern. Both the raw text and raw entities must match exactly.

^Source

Static Methods

b

b();

Creates a bold formatted string

^Source

bold

bold();

Creates a bold formatted string

^Source

i

i();

Creates an italic formatted string

^Source

italic

italic();

Creates an italic formatted string

^Source

s

s();

Creates a strikethrough formatted string

^Source

strikethrough

strikethrough();

Creates a strikethrough formatted string

^Source

u

u();

Creates an underline formatted string

^Source

underline

underline();

Creates an underline formatted string

^Source

a

a();

Creates a link formatted string

^Source

link

link();

Creates a link formatted string

^Source

code

code();

Creates a code formatted string

^Source

pre

pre();

Creates a pre formatted string (code block)

^Source

spoiler

spoiler();

Creates a spoiler formatted string

^Source

blockquote

blockquote();

Creates a blockquote formatted string

^Source

expandableBlockquote

expandableBlockquote();

Creates an expandable blockquote formatted string

^Source

mentionUser

mentionUser();

Creates a user mention formatted string

^Source

customEmoji

customEmoji();

^Source

emoji

emoji();

Creates an emoji formatted string using custom emoji

^Source

time

time();

Creates a date_time formatted string

^Source

linkMessage

linkMessage();

Creates a message link formatted string

^Source

join

join();

Joins an array of formatted strings or plain text into a single FormattedString

^Source

_split

_split();

Internal method that implements the shared splitting logic for both split and splitByText methods

^Source

split

split();

Splits a FormattedString into an array of FormattedStrings using a separator

^Source

splitByText

splitByText();

Splits a FormattedString into an array of FormattedStrings using a separator, ignoring inequalities in rawEntities. Only uses rawText to determine if this is a valid position to split.

^Source

startsWith

startsWith();

Static method to check whether a FormattedString starts with the specified pattern. Both the raw text and raw entities must match exactly.

^Source

endsWith

endsWith();

Static method to check whether a FormattedString ends with the specified pattern. Both the raw text and raw entities must match exactly.

^Source