1# htmlparser2 2 3[![NPM version](http://img.shields.io/npm/v/htmlparser2.svg?style=flat)](https://npmjs.org/package/htmlparser2) 4[![Downloads](https://img.shields.io/npm/dm/htmlparser2.svg?style=flat)](https://npmjs.org/package/htmlparser2) 5[![Build Status](http://img.shields.io/travis/fb55/htmlparser2/master.svg?style=flat)](http://travis-ci.org/fb55/htmlparser2) 6[![Coverage](http://img.shields.io/coveralls/fb55/htmlparser2.svg?style=flat)](https://coveralls.io/r/fb55/htmlparser2) 7 8A forgiving HTML/XML/RSS parser. 9The parser can handle streams and provides a callback interface. 10 11## Installation 12 13 npm install htmlparser2 14 15A live demo of htmlparser2 is available [here](https://astexplorer.net/#/2AmVrGuGVJ). 16 17## Usage 18 19```javascript 20const htmlparser2 = require("htmlparser2"); 21const parser = new htmlparser2.Parser( 22 { 23 onopentag(name, attribs) { 24 if (name === "script" && attribs.type === "text/javascript") { 25 console.log("JS! Hooray!"); 26 } 27 }, 28 ontext(text) { 29 console.log("-->", text); 30 }, 31 onclosetag(tagname) { 32 if (tagname === "script") { 33 console.log("That's it?!"); 34 } 35 } 36 }, 37 { decodeEntities: true } 38); 39parser.write( 40 "Xyz <script type='text/javascript'>var foo = '<<bar>>';</ script>" 41); 42parser.end(); 43``` 44 45Output (simplified): 46 47``` 48--> Xyz 49JS! Hooray! 50--> var foo = '<<bar>>'; 51That's it?! 52``` 53 54## Documentation 55 56Read more about the parser and its options in the [wiki](https://github.com/fb55/htmlparser2/wiki/Parser-options). 57 58## Get a DOM 59 60The `DomHandler` (known as `DefaultHandler` in the original `htmlparser` module) produces a DOM (document object model) that can be manipulated using the [`DomUtils`](https://github.com/fb55/DomUtils) helper. 61 62The `DomHandler`, while still bundled with this module, was moved to its [own module](https://github.com/fb55/domhandler). Have a look at it for further information. 63 64## Parsing RSS/RDF/Atom Feeds 65 66```javascript 67const feed = htmlparser2.parseFeed(content, options); 68``` 69 70Note: While the provided feed handler works for most feeds, you might want to use [danmactough/node-feedparser](https://github.com/danmactough/node-feedparser), which is much better tested and actively maintained. 71 72## Performance 73 74After having some artificial benchmarks for some time, **@AndreasMadsen** published his [`htmlparser-benchmark`](https://github.com/AndreasMadsen/htmlparser-benchmark), which benchmarks HTML parses based on real-world websites. 75 76At the time of writing, the latest versions of all supported parsers show the following performance characteristics on [Travis CI](https://travis-ci.org/AndreasMadsen/htmlparser-benchmark/builds/10805007) (please note that Travis doesn't guarantee equal conditions for all tests): 77 78``` 79gumbo-parser : 34.9208 ms/file ± 21.4238 80html-parser : 24.8224 ms/file ± 15.8703 81html5 : 419.597 ms/file ± 264.265 82htmlparser : 60.0722 ms/file ± 384.844 83htmlparser2-dom: 12.0749 ms/file ± 6.49474 84htmlparser2 : 7.49130 ms/file ± 5.74368 85hubbub : 30.4980 ms/file ± 16.4682 86libxmljs : 14.1338 ms/file ± 18.6541 87parse5 : 22.0439 ms/file ± 15.3743 88sax : 49.6513 ms/file ± 26.6032 89``` 90 91## How does this module differ from [node-htmlparser](https://github.com/tautologistics/node-htmlparser)? 92 93This module started as a fork of the `htmlparser` module. 94The main difference is that `htmlparser2` is intended to be used only with node (it runs on other platforms using [browserify](https://github.com/substack/node-browserify)). 95`htmlparser2` was rewritten multiple times and, while it maintains an API that's compatible with `htmlparser` in most cases, the projects don't share any code anymore. 96 97The parser now provides a callback interface inspired by [sax.js](https://github.com/isaacs/sax-js) (originally targeted at [readabilitySAX](https://github.com/fb55/readabilitysax)). 98As a result, old handlers won't work anymore. 99 100The `DefaultHandler` and the `RssHandler` were renamed to clarify their purpose (to `DomHandler` and `FeedHandler`). The old names are still available when requiring `htmlparser2`, your code should work as expected. 101 102## Security contact information 103 104To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). 105Tidelift will coordinate the fix and disclosure. 106 107## `htmlparser2` for enterprise 108 109Available as part of the Tidelift Subscription 110 111The maintainers of `htmlparser2` and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-htmlparser2?utm_source=npm-htmlparser2&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) 112