Fast HTML Parser  

Fast 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
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
`

> Note: when using Fast HTML Parser in a Typescript project the minimum Typescript version supported is ^4.1.2.

Performance

-- 2022-08-10

`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.21317
`

Tested with htmlparser-benchmark.

Usage

`ts
import { parse } from 'node-html-parser';

const root = parse('

• Hello World

');

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());
//

• Hello World

root.set_content('

Hello World

');
root.toString(); //

Hello World

`

`js
var HTMLParser = require('node-html-parser');

var root = HTMLParser.parse('

• Hello World

');
`

Global Methods

$3

Parse the data provided, and return the root of the generated DOM.

- data, data to parse
- options, parse options

`js
{
lowerCaseTagName: false, // convert tag name to lower case (hurts performance heavily)
comment: false, // retrieve comments (hurts performance slightly)
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']
addClosingSlash: 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

Parse the data provided, return true if the given data is valid, and return false if not.

HTMLElement Methods

$3

Trim element from right (in block) after seeing pattern in a TextNode.

$3

Remove whitespaces in this sub tree.

$3

Query CSS selector to find matching nodes.

Note: Full range of CSS3 selectors supported since v3.0.0.

$3

Query CSS Selector to find matching node.

$3

Get all elements with the specified tagName.

Note: Use * for all elements.

$3

Query closest element by css selector.

$3

Append a child node to childNodes

$3

Parses the specified text as HTML and inserts the resulting nodes into the DOM tree at a specified position.

$3

Set value to key attribute.

$3

Set attributes of the element.

$3

Remove key attribute.

$3

Get key attribute.

$3

Exchanges given child with new child.

$3

Remove child node.

$3

Same as outerHTML

$3

Set content. Notice: Do not set content of the root node.

$3

Remove current element.

$3

Replace current element with other node(s).

$3

#### HTMLElement#classList.add

Add class name.

#### HTMLElement#classList.replace(old: string, new: string)

Replace class name with another one.

#### HTMLElement#classList.remove()

Remove class name.

#### HTMLElement#classList.toggle(className: string):void

Toggle class. Remove it if it is already included, otherwise add.

#### HTMLElement#classList.contains(className: string): boolean

Returns true if the classname is already in the classList.

#### HTMLElement#classList.values()

Get class names.

#### Node#clone()

Clone a node.

#### Node#getElementById(id: string): HTMLElement;

Get element by it's ID.

HTMLElement Properties

$3

Get unescaped text value of current node and its children. Like innerText.
(slow for the first time)

$3

Get escaped (as-is) text value of current node and its children. May have
&` in it. (fast)

$3

Get or Set tag name of HTMLElement. Notice: the returned value would be an uppercase string.

$3

Get structured Text.

$3

Get DOM structure.

$3

Get first child node.

$3

Get last child node.

$3

Set or Get innerHTML.

$3

Get outerHTML.

$3

Returns a reference to the next child node of the current element's parent.

$3

Returns a reference to the next child element of the current element's parent.

$3

Returns a reference to the previous child node of the current element's parent.

$3

Returns a reference to the previous child element of the current element's parent.

$3

Get or Set textContent of current element, more efficient than set_content.

$3

Get all attributes of current element. Notice: do not try to change the returned value.

$3

Get all attributes of current element. Notice: do not try to change the returned value.

$3

Corresponding source code start and end indexes (ie [ 0, 40 ])