A very fast HTML parser, generating a simplified DOM, with basic element query support.
npm install node-html-parserFast HTML Parser is a _very fast_ HTML parser. Which will generate a simplified
DOM tree, with element query support.
Per the design, it intends to parse massive HTML files in lowest price, thus the `` > Note: when using Fast HTML Parser in a Typescript project the minimum Typescript version supported is ^4.1.2 -- 2022-08-10 ` Tested with htmlparser-benchmark. ` const root = parse(' // parse() adds a wrapper node, so the input data's first node is the root's first child node console.log(root.querySelector('#list')); var root = HTMLParser.parse(' Parse the data provided, wrap the result in a new node, and return the root of the generated DOM. - data, data to parse Parse the data provided, return true if the given 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 range of CSS3 selectors supported since v3.0.0. Query CSS Selector to find matching node. Get all elements with the specified tagName. Note: Use * for all elements. Query closest element by css selector. Insert one or multiple nodes or text before the current element. Does not work on root. Insert one or multiple nodes or text after the current element. Does not work on root. Insert one or multiple nodes or text to the first position of an element's child nodes. Insert one or multiple nodes or text to the last position of an element's child nodes. Append a node to an element's child nodes. Parses the specified text as HTML and inserts the resulting nodes into the DOM tree at a specified position. Set Set attributes of the element. Remove Get 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). #### classList.add Add class name. #### classList.replace(old: string, new: string) Replace class name with another one. #### classList.remove() Remove class name. #### classList.toggle(className: string):void Toggle class. Remove it if it is already included, otherwise add. #### classList.contains(className: string): boolean Returns true if the classname is already in the classList. #### classList.value Get class names. #### clone() Clone a node. #### getElementById(id: string): HTMLElement | null Get element by it's ID. Get unescaped text value of current node and its children. Like Get escaped (as-is) text value of current node and its children. May have Get or Set tag name of HTMLElement. Note that the returned value is an uppercase string. Get structured Text. Get DOM structure. Get all child nodes. A child node can be a TextNode, a CommentNode and a HTMLElement. Get all child elements, so all child nodes of type HTMLELement. Get first child node of the wrapper node added by Get last child node of the wrapper node added by Get the first child of type HTMLElement. Get the first child of type HTMLElement. Get the number of children that are of type HTMLElement. 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. Returns a reference to the previous child node of the current element's parent. Returns a reference to the previous 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. Corresponding source code start and end indexes (ie [ 0, 40 ])
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 etc). Install
shell`
npm install --save node-html-parser.Performance
shell`
html-parser :24.1595 ms/file ± 18.7667
htmljs-parser :4.72064 ms/file ± 5.67689
html-dom-parser :2.18055 ms/file ± 2.96136
html5parser :1.69639 ms/file ± 2.17111
cheerio :12.2122 ms/file ± 8.10916
parse5 :6.50626 ms/file ± 4.02352
htmlparser2 :2.38179 ms/file ± 3.42389
htmlparser :17.4820 ms/file ± 128.041
high5 :3.95188 ms/file ± 2.52313
node-html-parser:2.04288 ms/file ± 1.25203
node-html-parser (last release):2.00527 ms/file ± 1.21317Usage
ts
import { parse } from 'node-html-parser';
');
console.log(root.firstChild.structure);
// ul#list
// li
// #text
// { tagName: 'ul',
// rawAttrs: 'id="list"',
// childNodes:
// [ { tagName: 'li',
// rawAttrs: '',
// childNodes: [Object],
// classNames: [] } ],
// id: 'list',
// classNames: [] }
console.log(root.toString());
//
root.set_content('
root.toString(); //
``js`
var HTMLParser = require('node-html-parser');
');Global Methods
$3
- options, parse optionsjs`
{
lowerCaseTagName: false, // convert tag name to lower case (hurts performance heavily)
comment: false, // retrieve comments (hurts performance slightly)
fixNestedATags: false, // fix invalid nested HTML tags
parseNoneClosedTags: false, // close none closed HTML tags instead of removing them
voidTag: {
tags: ['area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'link', 'meta', 'param', 'source', 'track', 'wbr'], // optional and case insensitive, default value is ['area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'link', 'meta', 'param', 'source', 'track', 'wbr']
closingSlash: true // optional, default false. void tag serialisation, add a final slash
},
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
}
}
$3
Class
mermaid`
classDiagram
direction TB
class HTMLElement{
this trimRight()
this removeWhitespace()
Node[] querySelectorAll(string selector)
Node querySelector(string selector)
HTMLElement[] getElementsByTagName(string tagName)
Node closest(string selector)
Node appendChild(Node node)
this insertAdjacentHTML('beforebegin' | 'afterbegin' | 'beforeend' | 'afterend' where, string html)
this setAttribute(string key, string value)
this setAttributes(Record string, string attrs)
this removeAttribute(string key)
string getAttribute(string key)
this exchangeChild(Node oldNode, Node newNode)
this removeChild(Node node)
string toString()
this set_content(string content)
this set_content(Node content)
this set_content(Node[] content)
this remove()
this replaceWith((string | Node)[] ...nodes)
ClassList classList
HTMLElement clone()
HTMLElement getElementById(string id)
string text
string rawText
string tagName
string structuredText
string structure
Node firstChild
Node lastChild
Node nextSibling
HTMLElement nextElementSibling
Node previousSibling
HTMLElement previousElementSibling
string innerHTML
string outerHTML
string textContent
Record
[number, number] range
}
class Node{
<
string toString()
Node clone()
this remove()
number nodeType
string innerText
string textContent
}
class ClassList{
add(string c)
replace(string c1, string c2)
remove(string c)
toggle(string c)
boolean contains(string c)
number length
string[] value
string toString()
}
class CommentNode{
CommentNode clone()
string toString()
}
class TextNode{
TextNode clone()
string toString()
string rawText
string trimmedRawText
string trimmedText
string text
boolean isWhitespace
}
Node --|> HTMLElement
Node --|> CommentNode
Node --|> TextNode
Node ..> ClassListHTMLElement Methods
$3
$3
$3
$3
if not found.null$3
$3
if not found.value$3
$3
$3
$3
This is similar to appendChild, but accepts arbitrarily many nodes and converts strings to text nodes.$3
$3
$3
to key attribute.key$3
$3
attribute.key$3
attribute. undefined if not set.innerText$3
$3
$3
$3
$3
$3
$3
HTMLElement Properties
$3
.&
(slow for the first time)$3
in it. (fast)parse()$3
$3
$3
$3
$3
$3
. undefined if the node has no children.parse()$3
. undefined if the node has no children.undefined$3
if none exists.undefined$3
if none exists.null$3
$3
$3
$3
if not found.null$3
if not found.null$3
if not found.null` if not found.$3
$3
$3
$3