Class MarkdownStringImpl

Implements

MarkdownString

Index

Constructors

Properties

baseUri? isTrusted? supportHtml? supportThemeIcons? value

Methods

_escape appendCodeblock appendLink appendMarkdown appendText

Constructors

constructor

new MarkdownStringImpl(value?, isTrustedOrOptions?): MarkdownStringImpl
Parameters
- value: string = ''
- isTrustedOrOptions: boolean | {
      isTrusted?: boolean;
      supportHtml?: boolean;
      supportThemeIcons?: boolean;
  } = false
Returns MarkdownStringImpl
- Defined in packages/core/src/common/markdown-rendering/markdown-string.ts:58

Properties

`Optional` baseUri

baseUri?: UriComponents

`Optional` isTrusted

isTrusted?: boolean | MarkdownStringTrustedOptions

`Optional` supportHtml

supportHtml?: boolean

`Optional` supportThemeIcons

supportThemeIcons?: boolean

value

value: string

Methods

`Private` _escape

_escape(value, ch): string
Parameters
- value: string
- ch: string
Returns string
- Defined in packages/core/src/common/markdown-rendering/markdown-string.ts:113

appendCodeblock

appendCodeblock(langId, code): MarkdownStringImpl
Parameters
- langId: string
- code: string
Returns MarkdownStringImpl
- Defined in packages/core/src/common/markdown-rendering/markdown-string.ts:92

appendLink

appendLink(target, label, title?): MarkdownStringImpl
Parameters
- target: string | UriComponents
- label: string
- Optional title: string
Returns MarkdownStringImpl
- Defined in packages/core/src/common/markdown-rendering/markdown-string.ts:101

appendMarkdown

appendMarkdown(value): MarkdownStringImpl
Parameters
- value: string
Returns MarkdownStringImpl
- Defined in packages/core/src/common/markdown-rendering/markdown-string.ts:87

appendText

appendText(value, newlineStyle?): MarkdownStringImpl
Parameters
- value: string
- newlineStyle: MarkdownStringTextNewlineStyle = MarkdownStringTextNewlineStyle.Paragraph
Returns MarkdownStringImpl
- Defined in packages/core/src/common/markdown-rendering/markdown-string.ts:78