Trilium Backend API
    Preparing search index...

    Options accepted by Cheerio.

    Please note that parser-specific options are only recognized if the relevant parser is used.

    interface DecodeStreamOptions {
        baseURI?: string | URL;
        encoding?: SnifferOptions;
        onParseError?: ParserErrorHandler;
        pseudos?: Record<
            string,
            string
            | ((elem: Element, value?: string) => boolean),
        >;
        quirksMode?: boolean;
        scriptingEnabled?: boolean;
        sourceCodeLocationInfo?: boolean;
        treeAdapter?: TreeAdapter<Htmlparser2TreeAdapterMap>;
        xml?: boolean | HTMLParser2Options;
        xmlMode?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    baseURI?: string | URL

    The base URI for the document. Used to resolve the href and src props.

    encoding?: SnifferOptions
    onParseError?: ParserErrorHandler

    Callback for parse errors.

    null

    pseudos?: Record<string, string | ((elem: Element, value?: string) => boolean)>

    Extension point for pseudo-classes.

    Maps from names to either strings of functions.

    • A string value is a selector that the element must match to be selected.
    • A function is called with the element as its first argument, and optional parameters second. If it returns true, the element is selected.
    const $ = cheerio.load(
    '<div class="foo"></div><div data-bar="boo"></div>',
    {
    pseudos: {
    // `:foo` is an alias for `div.foo`
    foo: 'div.foo',
    // `:bar(val)` is equivalent to `[data-bar=val s]`
    bar: (el, val) => el.attribs['data-bar'] === val,
    },
    },
    );

    $(':foo').length; // 1
    $('div:bar(boo)').length; // 1
    $('div:bar(baz)').length; // 0
    quirksMode?: boolean

    Is the document in quirks mode?

    This will lead to .className and #id being case-insensitive.

    false
    
    scriptingEnabled?: boolean

    The scripting flag. If set to true, noscript element content will be parsed as text.

    true

    sourceCodeLocationInfo?: boolean

    Enables source code location information. When enabled, each node (except the root node) will have a sourceCodeLocation property. If the node is not an empty element, sourceCodeLocation will be a ElementLocation object, otherwise it will be Location. If the element was implicitly created by the parser (as part of tree correction), its sourceCodeLocation property will be undefined.

    false

    Specifies the resulting tree format.

    treeAdapters.default

    xml?: boolean | HTMLParser2Options

    Recommended way of configuring htmlparser2 when wanting to parse XML.

    This will switch Cheerio to use htmlparser2.

    false
    
    xmlMode?: boolean

    Enable xml mode, which will switch Cheerio to use htmlparser2.

    Please use the xml option instead.

    false