node-html-parser 4.1.4 → 5.2.0

package/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [5.1.0](https://github.com/taoqf/node-fast-html-parser/compare/v4.1.5...v5.1.0) (2021-10-28)
+
+### Features
+
+* Exposed `HTMLElement#rawAttrs` (made public) ([34f1595](https://github.com/taoqf/node-fast-html-parser/commit/34f1595756c0974b6ae7ef5755a615f09e421f32))
+
+## [5.0.0](https://github.com/taoqf/node-fast-html-parser/compare/v4.1.5...v5.0.0) (2021-10-10)
+
+
+### ⚠ BREAKING CHANGES
+
+* Added esm named export support ([0d4b922](https://github.com/taoqf/node-fast-html-parser/commit/0d4b922eefd6210fe802991e464b21b0c69d5f63))
+
+### Features
+
+* Added esm named export support (closes [#160](https://github.com/taoqf/node-fast-html-parser/issues/160) closes [#139](https://github.com/taoqf/node-fast-html-parser/issues/139)) ([0d4b922](https://github.com/taoqf/node-fast-html-parser/commit/0d4b922eefd6210fe802991e464b21b0c69d5f63))
+* Added HTMLElement#getElementsByTagName ([d462e44](https://github.com/taoqf/node-fast-html-parser/commit/d462e449e7ebb00a5a43fb574133681ad5a62475))
+* Improved parsing performance + matching (closes [#164](https://github.com/taoqf/node-fast-html-parser/issues/164)) ([3c5b8e2](https://github.com/taoqf/node-fast-html-parser/commit/3c5b8e2a9104b01a8ca899a7970507463e42adaf))
+
+
+### Bug Fixes
+
+* Add null to return type for HTMLElement#querySelector (closes [#157](https://github.com/taoqf/node-fast-html-parser/issues/157)) ([2b65583](https://github.com/taoqf/node-fast-html-parser/commit/2b655839bd3868c41fb19cae5786ca097565bc7f))
+* blockTextElements incorrectly matching partial tag (detail) (fixes [#156](https://github.com/taoqf/node-fast-html-parser/issues/156) fixes [#124](https://github.com/taoqf/node-fast-html-parser/issues/124)) ([6823349](https://github.com/taoqf/node-fast-html-parser/commit/6823349fdf1809c7484c70d948aa24930ef4983f))

package/README.md

@@ -1,4 +1,4 @@
-# Fast HTML Parser [![NPM version](https://badge.fury.io/js/node-html-parser.png)](http://badge.fury.io/js/node-html-parser) [![Build Status](https://travis-ci.org/taoqf/node-html-parser.svg?branch=master)](https://travis-ci.org/taoqf/node-html-parser)
+# Fast HTML Parser [![NPM version](https://badge.fury.io/js/node-html-parser.png)](http://badge.fury.io/js/node-html-parser) [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Ftaoqf%2Fnode-html-parser%2Fbadge%3Fref%3Dmain&style=flat)](https://actions-badge.atrox.dev/taoqf/node-html-parser/goto?ref=main)
 
 Fast HTML Parser is a _very fast_ HTML parser. Which will generate a simplified
 DOM tree, with element query support.
@@ -19,15 +19,18 @@ npm install --save node-html-parser
 
 ## Performance
 
-Faster than htmlparser2!
-
 ```shell
-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
+cheerio         :12.0726 ms/file ± 7.31605
+parse5          :8.18615 ms/file ± 6.15337
+node-html-parser (last release):2.16533 ms/file ± 1.56924
+htmlparser      :17.0658 ms/file ± 120.901
+htmlparser2     :2.62695 ms/file ± 4.17579
+node-html-parser:2.14907 ms/file ± 1.66632
+html-parser     :24.6505 ms/file ± 18.9996
+htmljs-parser   :5.81797 ms/file ± 6.55537
+html-dom-parser :2.52265 ms/file ± 3.54858
+html5parser     :2.01144 ms/file ± 2.53570
+high5           :3.91342 ms/file ± 2.65563
 ```
 
 Tested with [htmlparser-benchmark](https://github.com/AndreasMadsen/htmlparser-benchmark).
@@ -70,15 +73,15 @@ var root = HTMLParser.parse('<ul id="list"><li>Hello World</li></ul>');
 
 ### parse(data[, options])
 
-Parse given data, and return root of the generated DOM.
+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 (hurt performance heavily)
-    comment: false            // retrieve comments (hurt performance slightly)
+    lowerCaseTagName: false,  // convert tag name to lower case (hurts performance heavily)
+    comment: false,            // retrieve comments (hurts performance slightly)
     blockTextElements: {
       script: true,	// keep text content when parsing
       noscript: true,	// keep text content when parsing
@@ -90,7 +93,7 @@ Parse given data, and return root of the generated DOM.
 
 ### valid(data[, options])
 
-Parse given data, return true if the givent data is valid, and return false if not.
+Parse the data provided, return true if the given data is valid, and return false if not.
 
 ## HTMLElement Methods
 
@@ -106,12 +109,18 @@ Remove whitespaces in this sub tree.
 
 Query CSS selector to find matching nodes.
 
-Note: Full css3 selector supported since v3.0.0.
+Note: Full range of CSS3 selectors supported since v3.0.0.
 
 ### HTMLElement#querySelector(selector)
 
 Query CSS Selector to find matching node.
 
+### HTMLElement#getElementsByTagName(tagName)
+
+Get all elements with the specified tagName.
+
+Note: Use * for all elements.
+
 ### HTMLElement#closest(selector)
 
 Query closest element by css selector.
@@ -122,7 +131,7 @@ Append a child node to childNodes
 
 ### HTMLElement#insertAdjacentHTML(where, html)
 
-parses the specified text as HTML and inserts the resulting nodes into the DOM tree at a specified position.
+Parses the specified text as HTML and inserts the resulting nodes into the DOM tree at a specified position.
 
 ### HTMLElement#setAttribute(key: string, value: string)
 
@@ -180,15 +189,15 @@ Remove class name.
 
 #### HTMLElement#classList.toggle(className: string):void
 
-Toggle class.
+Toggle class. Remove it if it is already included, otherwise add.
 
 #### HTMLElement#classList.contains(className: string): boolean
 
-Get if contains
+Returns true if the classname is already in the classList.
 
 #### HTMLElement#classList.values()
 
-get class names
+Get class names.
 
 ## HTMLElement Properties
 
@@ -199,28 +208,28 @@ Get unescaped text value of current node and its children. Like `innerText`.
 
 ### HTMLElement#rawText
 
-Get escpaed (as-it) text value of current node and its children. May have
+Get escaped (as-is) text value of current node and its children. May have
 `&amp;` in it. (fast)
 
 ### HTMLElement#tagName
 
-Get tag name of HTMLElement. Notice: the returned value would be an uppercase string.
+Get or Set tag name of HTMLElement. Notice: the returned value would be an uppercase string.
 
 ### HTMLElement#structuredText
 
-Get structured Text
+Get structured Text.
 
 ### HTMLElement#structure
 
-Get DOM structure
+Get DOM structure.
 
 ### HTMLElement#firstChild
 
-Get first child node
+Get first child node.
 
 ### HTMLElement#lastChild
 
-Get last child node
+Get last child node.
 
 ### HTMLElement#innerHTML
 
@@ -252,4 +261,4 @@ Get all attributes of current element. **Notice: do not try to change the return
 
 ### HTMLElement#range
 
-Corresponding source code start and end indexes (ie [ 0, 40 ])
+Corresponding source code start and end indexes (ie [ 0, 40 ])