Trilium Backend API
    Preparing search index...

    Interface HTMLParser2Options

    Options accepted by htmlparser2, the default parser for XML.

    https://github.com/fb55/htmlparser2/wiki/Parser-options

    interface HTMLParser2Options {
        decodeEntities?: boolean;
        emptyAttrs?: boolean;
        encodeEntities?: boolean | "utf8";
        lowerCaseAttributeNames?: boolean;
        lowerCaseTags?: boolean;
        recognizeCDATA?: boolean;
        recognizeSelfClosing?: boolean;
        selfClosingTags?: boolean;
        Tokenizer?: typeof default;
        withEndIndices?: boolean;
        withStartIndices?: boolean;
        xmlMode?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    decodeEntities? emptyAttrs? encodeEntities? lowerCaseAttributeNames? lowerCaseTags? recognizeCDATA? recognizeSelfClosing? selfClosingTags? Tokenizer? withEndIndices? withStartIndices? xmlMode?

    Properties

    decodeEntities?: boolean

    Option inherited from parsing; will be used as the default value for encodeEntities.

    true
    emptyAttrs?: boolean

    Print an empty attribute's value.

    xmlMode

    With <code>emptyAttrs: false</code>: <code>&lt;input checked&gt;</code>

    With <code>emptyAttrs: true</code>: <code>&lt;input checked=""&gt;</code>
    encodeEntities?: boolean | "utf8"

    Encode characters that are either reserved in HTML or XML.

    If xmlMode is true or the value not 'utf8', characters outside of the utf8 range will be encoded as well.

    decodeEntities

    lowerCaseAttributeNames?: boolean

    If set to true, all attribute names will be lowercased. This has noticeable impact on speed.

    !xmlMode
    lowerCaseTags?: boolean

    If set to true, all tags will be lowercased.

    !xmlMode
    recognizeCDATA?: boolean

    If set to true, CDATA sections will be recognized as text even if the xmlMode option is not enabled. NOTE: If xmlMode is set to true then CDATA sections will always be recognized as text.

    xmlMode
    recognizeSelfClosing?: boolean

    If set to true, self-closing tags will trigger the onclosetag event even if xmlMode is not set to true. NOTE: If xmlMode is set to true then self-closing tags will always be recognized.

    xmlMode
    selfClosingTags?: boolean

    Print self-closing tags for tags without contents.

    xmlMode

    With <code>selfClosingTags: false</code>: <code>&lt;foo&gt;&lt;/foo&gt;</code>

    With <code>selfClosingTags: true</code>: <code>&lt;foo /&gt;</code>
    Tokenizer?: typeof default

    Allows the default tokenizer to be overwritten.

    withEndIndices?: boolean

    Add an endIndex property to nodes. When the parser is used in a non-streaming fashion, endIndex is an integer indicating the position of the end of the node in the document.

    false
    withStartIndices?: boolean

    Add a startIndex property to nodes. When the parser is used in a non-streaming fashion, startIndex is an integer indicating the position of the start of the node in the document.

    false
    xmlMode?: boolean

    Treat the input as an XML document.

    Settings

    Member Visibility

    On This Page

    Properties