Variable mdConst

Type Declaration

• • (
        strings: TemplateStringsArray,
        ...sub: (
            number
            | boolean
            | Long
            | InputText
            | MessageEntity
            | null
            | undefined
        )[],
    ): TextWithEntities

  • Tagged template based Markdown-to-entities parser function

    Additionally, md function has two static methods:

    • md.escape - escape a string to be safely used in Markdown (should not be needed in most cases, as md function itself handles all strings passed to it automatically as plain text)
    • md.unparse - add Markdown formatting to the text given the plain text and entities contained in it

    Parameters

    • strings: TemplateStringsArray
    • ...sub: (number | boolean | Long | InputText | MessageEntity | null | undefined)[]

    Returns TextWithEntities

    Example

    const text = md`**${user.displayName}**`
    Copy

  • (string: string): TextWithEntities

  • A variant taking a plain JS string as input and parsing it.

    Useful for cases when you already have a string (e.g. from some server) and want to parse it.

    Parameters

    • string: string

    Returns TextWithEntities

    Example

    const string = '**hello**'
    const text = md(string)
    Copy

• escape: typeof escape

• unparse: typeof unparse