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 <td> etc).
Install
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.
import { parse } from 'node-html-parser';const root = parse('<ul id="list"><li>Hello World</li></ul>');// parse() adds a wrapper node, so the input data's first node is the root's first child nodeconsole.log(root.firstChild.structure);// ul#list// li// #textconsole.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>');
Global Methods
parse(data[, options])
Parse the data provided, wrap the result in a new node, and return the root of the generated DOM.
data, data to parse
options, parse options
{ lowerCaseTagName: false, // convert tag name to lower case (hurts performance heavily) comment: false, // retrieve comments (hurts performance slightly) fixNestedATags: false, // fix invalid nested <a> HTML tags parseNoneClosedTags: false, // close none closed HTML tags instead of removing them preserveTagNesting: false, // preserve invalid HTML nesting instead of auto-closing tags (e.g. <p><p>bar</p></p>) 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 <br/> }, 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 }, closeAllByClosing: false // Close all non-closed tags when containing element closes}
valid(data[, options])
Parse the data provided, return true if the given data is valid, and return false if not.
Class
classDiagramdirection TBclass HTMLElement{ this trimRight() this removeWhitespace() Node[] querySelectorAll(string selector) Node querySelector(string selector) boolean matches(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<string, string> attributes [number, number] range}class Node{ <<abstract>> 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 --|> HTMLElementNode --|> CommentNodeNode --|> TextNodeNode ..> ClassList
HTMLElement Methods
trimRight()
Trim element from right (in block) after seeing pattern in a TextNode.
removeWhitespace()
Remove whitespaces in this sub tree.
querySelectorAll(selector)
Query CSS selector to find matching nodes.
Note: Full range of CSS3 selectors supported since v3.0.0.
querySelector(selector)
Query CSS Selector to find matching node. null if not found.
matches(selector)
Tests whether the node matches a given CSS selector.
getElementsByTagName(tagName)
Get all elements with the specified tagName.
Note: Use * for all elements.
closest(selector)
Query closest element by css selector. null if not found.
before(...nodesOrStrings)
Insert one or multiple nodes or text before the current element. Does not work on root.
after(...nodesOrStrings)
Insert one or multiple nodes or text after the current element. Does not work on root.
prepend(...nodesOrStrings)
Insert one or multiple nodes or text to the first position of an element's child nodes.
append(...nodesOrStrings)
Insert one or multiple nodes or text to the last position of an element's child nodes.
This is similar to appendChild, but accepts arbitrarily many nodes and converts strings to text nodes.
appendChild(node)
Append a node to an element's child nodes.
insertAdjacentHTML(where, html)
Parses the specified text as HTML and inserts the resulting nodes into the DOM tree at a specified position.