Function html

html(
    strings: TemplateStringsArray,
    ...sub: (
        undefined
        | null
        | number
        | boolean
        | Long
        | InputText
        | MessageEntity
    )[],
): TextWithEntities
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
- ...sub: (undefined | null | number | boolean | Long | InputText | MessageEntity)[]
Returns TextWithEntities
Example
```
const text = html`<b>${user.displayName}</b>`
```
- Defined in packages/html-parser/src/index.ts:461
html(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 = '<b>hello</b>'
const text = html(string)
```
- Defined in packages/html-parser/src/index.ts:478

Index

Properties

Properties

escape

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

Type declaration

- (str: string, quote?: boolean): 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

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

Type declaration

- (input: InputText, options?: HtmlUnparseOptions): string
- Add HTML formatting to the text given the plain text and entities contained in it.
  Parameters
  - input: InputText
  - Optionaloptions: HtmlUnparseOptions
  Returns string