Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MarkdownString

The MarkdownString represents human readable text that supports formatting via the markdown syntax. Standard markdown is supported, also tables, but no embedded html.

Hierarchy

  • MarkdownString

Index

Constructors

constructor

  • Creates a new markdown string with the given value.

    Parameters

    • Optional value: string

      Optional, initial value.

    Returns MarkdownString

Properties

Optional isTrusted

isTrusted: boolean

Indicates that this markdown string is from a trusted source. Only trusted markdown supports links that execute commands, e.g. [Run it](command:myCommandId).

value

value: string

The markdown string.

Methods

appendCodeblock

appendMarkdown

  • Appends the given string 'as is' to this markdown string.

    Parameters

    • value: string

      Markdown string.

    Returns MarkdownString

appendText

  • Appends and escapes the given string to this markdown string.

    Parameters

    • value: string

      Plain text.

    Returns MarkdownString