The DOM handler creates a tree containing all nodes of a page. The tree may be manipulated using the domutils or cheerio libraries.
const handler = new DomHandler([ <func> callback(err, dom), ] [ <obj> options ]);
// const parser = new Parser(handler[, options]);
Available options are described below.
const { Parser } = require("htmlparser2");
const { DomHandler } = require("domhandler");
const rawHtml =
"Xyz <script language= javascript>var foo = '<<bar>>';< / script><!--<!-- Waah! -- -->";
const handler = new DomHandler(function (error, dom) {
if (error) {
// Handle error
} else {
// Parsing completed, do something
console.log(dom);
}
});
const parser = new Parser(handler);
parser.write(rawHtml);
parser.end();
Output:
[
{
data: "Xyz ",
type: "text",
},
{
type: "script",
name: "script",
attribs: {
language: "javascript",
},
children: [
{
data: "var foo = '<bar>';<",
type: "text",
},
],
},
{
data: "<!-- Waah! -- ",
type: "comment",
},
];
Indicates whether the whitespace in text nodes should be normalized (= all whitespace should be replaced with single spaces).
The default value is false
.
For the following examples, this HTML will be used:
<font> <br />this is the text <font></font></font>
[
{
type: "tag",
name: "font",
children: [
{
data: " ",
type: "text",
},
{
type: "tag",
name: "br",
},
{
data: "this is the text ",
type: "text",
},
{
type: "tag",
name: "font",
},
],
},
];
[
{
type: "tag",
name: "font",
children: [
{
data: "\n\t",
type: "text",
},
{
type: "tag",
name: "br",
},
{
data: "this is the text\n",
type: "text",
},
{
type: "tag",
name: "font",
},
],
},
];
Indicates whether a startIndex
property will be added 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.
The default value is false
.
Indicates whether a endIndex
property will be added 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.
The default value is false
.
License: BSD-2-Clause
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
Available as part of the Tidelift Subscription
The maintainers of domhandler
and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.