interface EscapeMarkdownOptions

export interface EscapeMarkdownOptions

The options that affect what will be escaped.

bold

bulletedList

optional
bold? : boolean = true

Whether to escape bold text.

optional
bulletedList? : boolean = false

Whether to escape bulleted lists.

optional
codeBlock? : boolean = true

Whether to escape code blocks.

optional
codeBlockContent? : boolean = true

Whether to escape text inside code blocks.

optional
escape? : boolean = true

Whether to escape \.

optional
heading? : boolean = false

Whether to escape headings.

optional
inlineCode? : boolean = true

Whether to escape inline code.

optional
inlineCodeContent? : boolean = true

Whether to escape text inside inline code.

optional
italic? : boolean = true

Whether to escape italics.

optional
maskedLink? : boolean = false

Whether to escape masked links.

optional
numberedList? : boolean = false

Whether to escape numbered lists.

optional
spoiler? : boolean = true

Whether to escape spoilers.

optional
strikethrough? : boolean = true

Whether to escape strikethroughs.

optional
underline? : boolean = true

Whether to escape underlines.

interface EscapeMarkdownOptions

Table of contents

Properties

Properties

optional
bold? : boolean = true

optional
bulletedList? : boolean = false

optional
codeBlock? : boolean = true

optional
codeBlockContent? : boolean = true

optional
escape? : boolean = true

optional
heading? : boolean = false

optional
inlineCode? : boolean = true

optional
inlineCodeContent? : boolean = true

optional
italic? : boolean = true

optional
maskedLink? : boolean = false

optional
numberedList? : boolean = false

optional
spoiler? : boolean = true

optional
strikethrough? : boolean = true

optional
underline? : boolean = true

interface EscapeMarkdownOptions

Table of contents

Properties

Properties

optionalbold? : boolean = true

optionalbulletedList? : boolean = false

optionalcodeBlock? : boolean = true

optionalcodeBlockContent? : boolean = true

optionalescape? : boolean = true

optionalheading? : boolean = false

optionalinlineCode? : boolean = true

optionalinlineCodeContent? : boolean = true

optionalitalic? : boolean = true

optionalmaskedLink? : boolean = false

optionalnumberedList? : boolean = false

optionalspoiler? : boolean = true

optionalstrikethrough? : boolean = true

optionalunderline? : boolean = true

optional
bold? : boolean = true

optional
bulletedList? : boolean = false

optional
codeBlock? : boolean = true

optional
codeBlockContent? : boolean = true

optional
escape? : boolean = true

optional
heading? : boolean = false

optional
inlineCode? : boolean = true

optional
inlineCodeContent? : boolean = true

optional
italic? : boolean = true

optional
maskedLink? : boolean = false

optional
numberedList? : boolean = false

optional
spoiler? : boolean = true

optional
strikethrough? : boolean = true

optional
underline? : boolean = true