aboutsummaryrefslogtreecommitdiff
path: root/node_modules/domhandler/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-05-03 15:35:00 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-05-03 15:35:00 +0200
commitde98e0b232509d5f40c135d540a70e415272ff85 (patch)
treea79222a5b58484ab3b80d18efcaaa7ccc4769b33 /node_modules/domhandler/readme.md
parente0c9d480a73fa629c1e4a47d3e721f1d2d345406 (diff)
node_modules
Diffstat (limited to 'node_modules/domhandler/readme.md')
-rw-r--r--node_modules/domhandler/readme.md99
1 files changed, 99 insertions, 0 deletions
diff --git a/node_modules/domhandler/readme.md b/node_modules/domhandler/readme.md
new file mode 100644
index 000000000..a9214a3dd
--- /dev/null
+++ b/node_modules/domhandler/readme.md
@@ -0,0 +1,99 @@
+#DOMHandler [![Build Status](https://secure.travis-ci.org/fb55/DomHandler.png)](http://travis-ci.org/fb55/DomHandler)
+
+The DOM handler (formally known as DefaultHandler) creates a tree containing all nodes of a page. The tree may be manipulated using the DOMUtils library.
+
+##Usage
+```javascript
+var handler = new DomHandler([ <func> callback(err, dom), ] [ <obj> options ]);
+// var parser = new Parser(handler[, options]);
+```
+
+##Example
+```javascript
+var htmlparser = require("htmlparser2");
+var rawHtml = "Xyz <script language= javascript>var foo = '<<bar>>';< / script><!--<!-- Waah! -- -->";
+var handler = new htmlparser.DomHandler(function (error, dom) {
+ if (error)
+ [...do something for errors...]
+ else
+ [...parsing done, do something...]
+ console.log(dom);
+});
+var parser = new htmlparser.Parser(handler);
+parser.write(rawHtml);
+parser.done();
+```
+
+Output:
+
+```javascript
+[{
+ data: 'Xyz ',
+ type: 'text'
+}, {
+ type: 'script',
+ name: 'script',
+ attribs: {
+ language: 'javascript'
+ },
+ children: [{
+ data: 'var foo = \'<bar>\';<',
+ type: 'text'
+ }]
+}, {
+ data: '<!-- Waah! -- ',
+ type: 'comment'
+}]
+```
+
+##Option: ignoreWhitespace
+Indicates whether the DOM should exclude text nodes that consists solely of whitespace. The default value is "false".
+
+The following HTML will be used:
+
+```html
+<font>
+ <br>this is the text
+<font>
+```
+
+###Example: true
+
+```javascript
+[{
+ type: 'tag',
+ name: 'font',
+ children: [{
+ type: 'tag',
+ name: 'br'
+ }, {
+ data: 'this is the text\n',
+ type: 'text'
+ }, {
+ type: 'tag',
+ name: 'font'
+ }]
+}]
+```
+
+###Example: false
+
+```javascript
+[{
+ type: 'tag',
+ name: 'font',
+ children: [{
+ data: '\n\t',
+ type: 'text'
+ }, {
+ type: 'tag',
+ name: 'br'
+ }, {
+ data: 'this is the text\n',
+ type: 'text'
+ }, {
+ type: 'tag',
+ name: 'font'
+ }]
+}]
+``` \ No newline at end of file