Class MarkdownString

Hierarchy

MarkdownString

Implements

MarkdownString

Index

Constructors

constructor

Properties

#delegate

Accessors

Methods

Constructors

constructor

new MarkdownString(value?: string, supportThemeIcons?: boolean): MarkdownString

- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:41
Parameters
- Optional value: string
- supportThemeIcons: boolean = false
Returns MarkdownString

Properties

Private Readonly #delegate

#delegate: MarkdownStringImpl

Accessors

baseUri

get baseUri(): undefined | Uri
set baseUri(value: undefined | Uri): void

Implementation of pluginAPI.MarkdownString.baseUri
- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:76
Returns undefined | Uri
Implementation of pluginAPI.MarkdownString.baseUri
- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:80
Parameters
- value: undefined | Uri
Returns void

isTrusted

get isTrusted(): undefined | boolean
set isTrusted(value: undefined | boolean): void

Implementation of pluginAPI.MarkdownString.isTrusted
- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:52
Returns undefined | boolean
Implementation of pluginAPI.MarkdownString.isTrusted
- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:56
Parameters
- value: undefined | boolean
Returns void

supportHtml

get supportHtml(): undefined | boolean
set supportHtml(value: undefined | boolean): void

Implementation of pluginAPI.MarkdownString.supportHtml
- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:68
Returns undefined | boolean
Implementation of pluginAPI.MarkdownString.supportHtml
- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:72
Parameters
- value: undefined | boolean
Returns void

supportThemeIcons

get supportThemeIcons(): undefined | boolean
set supportThemeIcons(value: undefined | boolean): void

Implementation of pluginAPI.MarkdownString.supportThemeIcons
- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:60
Returns undefined | boolean
Implementation of pluginAPI.MarkdownString.supportThemeIcons
- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:64
Parameters
- value: undefined | boolean
Returns void

value

get value(): string
set value(value: string): void

Implementation of pluginAPI.MarkdownString.value
- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:45
Returns string
Implementation of pluginAPI.MarkdownString.value
- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:48
Parameters
- value: string
Returns void

Methods

appendCodeblock

appendCodeblock(value: string, language?: string): MarkdownString

Implementation of pluginAPI.MarkdownString.appendCodeblock
- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:94
Parameters
- value: string
- Optional language: string
Returns MarkdownString

appendMarkdown

appendMarkdown(value: string): MarkdownString

Implementation of pluginAPI.MarkdownString.appendMarkdown
- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:89
Parameters
- value: string
Returns MarkdownString

appendText

appendText(value: string): MarkdownString

Implementation of pluginAPI.MarkdownString.appendText
- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:84
Parameters
- value: string
Returns MarkdownString

toJSON

toJSON(): MarkdownString

- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:99
Returns MarkdownString

Static isMarkdownString

isMarkdownString(thing: any): thing is MarkdownString

- Defined in packages/plugin-ext/src/plugin/markdown-string.ts:34
Parameters
- thing: any
Returns thing is MarkdownString
whether the thing is a markdown string implementation with helper methods.