Interface EscapeMarkdownOptions

The options that affect what will be escaped.

Hierarchy

  • EscapeMarkdownOptions

Properties

bold? bulletedList? codeBlock? codeBlockContent? escape? heading? inlineCode? inlineCodeContent? italic? maskedLink? numberedList? spoiler? strikethrough? underline?

Properties

Optional bold

bold?: boolean

Whether to escape bold text.

Default Value

true

Optional bulletedList

bulletedList?: boolean

Whether to escape bulleted lists.

Default Value

false

Optional codeBlock

codeBlock?: boolean

Whether to escape code blocks.

Default Value

true

Optional codeBlockContent

codeBlockContent?: boolean

Whether to escape text inside code blocks.

Default Value

true

Optional escape

escape?: boolean

Whether to escape \.

@defaultValue true

Optional heading

heading?: boolean

Whether to escape headings.

Default Value

false

Optional inlineCode

inlineCode?: boolean

Whether to escape inline code.

Default Value

true

Optional inlineCodeContent

inlineCodeContent?: boolean

Whether to escape text inside inline code.

Default Value

true

Optional italic

italic?: boolean

Whether to escape italics.

Default Value

true

Optional maskedLink

maskedLink?: boolean

Whether to escape masked links.

Default Value

false

Optional numberedList

numberedList?: boolean

Whether to escape numbered lists.

Default Value

false

Optional spoiler

spoiler?: boolean

Whether to escape spoilers.

Default Value

true

Optional strikethrough

strikethrough?: boolean

Whether to escape strikethroughs.

Default Value

true

Optional underline

underline?: boolean

Whether to escape underlines.

Default Value

true

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc