Class MessageEntity

constructor

• new MessageEntity(raw, _text?): MessageEntity

• Parameters

  • raw: TypeMessageEntity
  • Optional_text: string

  Returns MessageEntity

Optional Readonly_text

Readonlyraw

kind

• get kind():
      | "url"
      | "bold"
      | "email"
      | "mention"
      | "hashtag"
      | "cashtag"
      | "bot_command"
      | "phone_number"
      | "italic"
      | "underline"
      | "strikethrough"
      | "spoiler"
      | "code"
      | "bank_card"
      | "unknown"
      | "blockquote"
      | "pre"
      | "text_link"
      | "text_mention"
      | "emoji"

• Kind of the entity (see MessageEntityParams)

  Returns
      | "url"
      | "bold"
      | "email"
      | "mention"
      | "hashtag"
      | "cashtag"
      | "bot_command"
      | "phone_number"
      | "italic"
      | "underline"
      | "strikethrough"
      | "spoiler"
      | "code"
      | "bank_card"
      | "unknown"
      | "blockquote"
      | "pre"
      | "text_link"
      | "text_mention"
      | "emoji"

length

• get length(): number

• Length of the entity in UTF-16 code units.

  Since JS strings are UTF-16, you can use this as-is

  Returns number

offset

• get offset(): number

• Offset in UTF-16 code units to the start of the entity.

  Since JS strings are UTF-16, you can use this as-is

  Returns number

params

• get params(): MessageEntityParams

• Params of the entity

  Returns MessageEntityParams

text

• get text(): string

• Text contained in this entity.

  Note: This does not take into account that entities may overlap, and is only useful for simple cases.

  Returns string

is

• is<const T>(kind): this is MessageEntity & {
      kind: T;
      params:
          | Extract<{
              kind:
                  | "url"
                  | "bold"
                  | "email"
                  | "mention"
                  | "hashtag"
                  | "cashtag"
                  | "bot_command"
                  | "phone_number"
                  | "italic"
                  | "underline"
                  | "strikethrough"
                  | "spoiler"
                  | "code"
                  | "bank_card"
                  | "unknown";
          }, {
              kind: T;
          }>
          | Extract<{
              collapsible: boolean;
              kind: "blockquote";
          }, {
              kind: T;
          }>
          | Extract<{
              kind: "pre";
              language?: string;
          }, {
              kind: T;
          }>
          | Extract<{
              kind: "text_link";
              url: string;
          }, {
              kind: T;
          }>
          | Extract<{
              kind: "text_mention";
              userId: number;
          }, {
              kind: T;
          }>
          | Extract<{
              emojiId: Long;
              kind: "emoji";
          }, {
              kind: T;
          }>;
  }

• Checks if this entity is of the given type, and adjusts the type accordingly.

  Type Parameters

  • const T extends
        | "url"
        | "bold"
        | "email"
        | "mention"
        | "hashtag"
        | "cashtag"
        | "bot_command"
        | "phone_number"
        | "italic"
        | "underline"
        | "strikethrough"
        | "spoiler"
        | "code"
        | "bank_card"
        | "unknown"
        | "blockquote"
        | "pre"
        | "text_link"
        | "text_mention"
        | "emoji"

  Parameters

  • kind: T

  Returns this is MessageEntity & {
      kind: T;
      params:
          | Extract<{
              kind:
                  | "url"
                  | "bold"
                  | "email"
                  | "mention"
                  | "hashtag"
                  | "cashtag"
                  | "bot_command"
                  | "phone_number"
                  | "italic"
                  | "underline"
                  | "strikethrough"
                  | "spoiler"
                  | "code"
                  | "bank_card"
                  | "unknown";
          }, {
              kind: T;
          }>
          | Extract<{
              collapsible: boolean;
              kind: "blockquote";
          }, {
              kind: T;
          }>
          | Extract<{
              kind: "pre";
              language?: string;
          }, {
              kind: T;
          }>
          | Extract<{
              kind: "text_link";
              url: string;
          }, {
              kind: T;
          }>
          | Extract<{
              kind: "text_mention";
              userId: number;
          }, {
              kind: T;
          }>
          | Extract<{
              emojiId: Long;
              kind: "emoji";
          }, {
              kind: T;
          }>;
  }