• Tagged template based HTML-to-entities parser function

    Additionally, md function has two static methods:

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

    Parameters

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

    Returns TextWithEntities

    const text = html`<b>${user.displayName}</b>`
    
  • 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

    const string = '<b>hello</b>'
    const text = html(string)

Properties

Properties

escape: ((str: string, quote?: boolean) => string)

Type declaration

    • (str, quote?): string
    • Escape a string to be safely used in HTML.

      Note: this function is in most cases not needed, as html function handles all strings passed to it automatically as plain text.

      Parameters

      • str: string
      • quote: boolean = false

      Returns string

unparse: ((input: InputText, options?: HtmlUnparseOptions) => string)

Type declaration

    • (input, options?): string
    • Add HTML formatting to the text given the plain text and entities contained in it.

      Parameters

      Returns string