GramIO API Reference / gramio/dist / FormattableString

Class: FormattableString

Defined in: format/formattable-string-BKevNsLk.d.ts:8

Class-helper for work with formattable entities

Constructors

Constructor

new FormattableString(text, entities): FormattableString

Defined in: format/formattable-string-BKevNsLk.d.ts:14

Create new FormattableString

Parameters

Parameter	Type
text	string
entities	TelegramMessageEntity[]

Returns

FormattableString

Properties

Property	Type	Description	Defined in
entities	TelegramMessageEntity[]	Entities of FormattableString	format/formattable-string-BKevNsLk.d.ts:12
text	string	Text of FormattableString (auto covert to it if entities is unsupported)	format/formattable-string-BKevNsLk.d.ts:10

Methods

toJSON()

toJSON(): string

Defined in: format/formattable-string-BKevNsLk.d.ts:18

Returns

string

---

toString()

toString(): string

Defined in: format/formattable-string-BKevNsLk.d.ts:17

Returns

string

---

[hasInstance]()

static [hasInstance](value): value is FormattableString

Defined in: format/formattable-string-BKevNsLk.d.ts:19

Parameters

Parameter	Type
value	unknown

Returns

value is FormattableString

---

from()

static from(text, entities): FormattableString

Defined in: format/formattable-string-BKevNsLk.d.ts:16

Create new FormattableString

Parameters

Parameter	Type
text	string
entities	TelegramMessageEntity[]

Returns

FormattableString