Fast HTML Parser is a very fast HTML parser. Which will generate a simplified DOM tree, with basic element query support.
Per the design, it intends to parse massive HTML files in lowest price, thus the
performance is the top priority. For this reason, some malformatted HTML may not
be able to parse correctly, but most usual errors are covered (eg. HTML4 style
no closing <li>
, <td>
etc).
npm install --save node-html-parser
Note: when using Fast HTML Parser in a Typescript project the minimum Typescript version supported is
^4.1.2
.
Faster than htmlparser2!
htmlparser :26.7111 ms/file ± 170.066
cheerio :24.2480 ms/file ± 17.1711
parse5 :13.7239 ms/file ± 8.68561
high5 :7.75466 ms/file ± 5.33549
htmlparser2 :5.27376 ms/file ± 8.68456
node-html-parser:2.85768 ms/file ± 2.87784
Tested with htmlparser-benchmark.
import { parse } from 'node-html-parser';
const root = parse('<ul id="list"><li>Hello World</li></ul>');
console.log(root.firstChild.structure);
// ul#list
// li
// #text
console.log(root.querySelector('#list'));
// { tagName: 'ul',
// rawAttrs: 'id="list"',
// childNodes:
// [ { tagName: 'li',
// rawAttrs: '',
// childNodes: [Object],
// classNames: [] } ],
// id: 'list',
// classNames: [] }
console.log(root.toString());
// <ul id="list"><li>Hello World</li></ul>
root.set_content('<li>Hello World</li>');
root.toString(); // <li>Hello World</li>
var HTMLParser = require('node-html-parser');
var root = HTMLParser.parse('<ul id="list"><li>Hello World</li></ul>');
Parse given data, and return root of the generated DOM.
-
data, data to parse
-
options, parse options
{ lowerCaseTagName: false, // convert tag name to lower case (hurt performance heavily) comment: false // retrieve comments (hurt performance slightly) blockTextElements: { script: true, // keep text content when parsing noscript: true, // keep text content when parsing style: true, // keep text content when parsing pre: true // keep text content when parsing } }
Parse given data, return true if the givent data is valid, and return false if not.
Trim element from right (in block) after seeing pattern in a TextNode.
Remove whitespaces in this sub tree.
Query CSS selector to find matching nodes.
Note: Full css3 selector supported since v3.0.0.
Query CSS Selector to find matching node.
Append a child node to childNodes
parses the specified text as HTML and inserts the resulting nodes into the DOM tree at a specified position.
Set value
to key
attribute.
Set attributes of the element.
Remove key
attribute.
Get key
attribute.
Exchanges given child with new child.
Remove child node.
Same as outerHTML
Set content. Notice: Do not set content of the root node.
Remove current element.
Replace current element with other node(s).
Add class name.
Replace class name with another one.
Remove class name.
Toggle class.
Get if contains
get class names
Get unescaped text value of current node and its children. Like innerText
.
(slow for the first time)
Get escpaed (as-it) text value of current node and its children. May have
&
in it. (fast)
Get tag name of HTMLElement. Notice: the returned value would be an uppercase string.
Get structured Text
Get DOM structure
Get first child node
Get last child node
Set or Get innerHTML.
Get outerHTML.
Returns a reference to the next child node of the current element's parent.
Returns a reference to the next child element of the current element's parent.
Get or Set textContent of current element, more efficient than set_content.
Get all attributes of current element. Notice: do not try to change the returned value.
Get all attributes of current element. Notice: do not try to change the returned value.