API Reference

Objects

parse5 : object

## Typedefs

ElementLocationInfo : Object
LocationInfo : Object
ParserOptions : Object
SerializerOptions : Object
SAXParserOptions : Object

## parse5 : object **Kind**: global namespace

parse5 : object
- .ParserStream ⇐ stream.Writable
  - new ParserStream(options)
  - .document : ASTNode.<document>
  - "script" (scriptElement, documentWrite(html), resume)
- .SerializerStream ⇐ stream.Readable
  - new SerializerStream(node, [options])
- .SAXParser ⇐ stream.Transform
- .treeAdapters
- .parse(html, [options]) ⇒ ASTNode.<Document>
- .parseFragment([fragmentContext], html, [options]) ⇒ ASTNode.<DocumentFragment>
- .serialize(node, [options]) ⇒ String
- .stop()

parse5.ParserStream ⇐ `stream.Writable`

Kind: instance class of parse5
Extends: stream.Writable

.ParserStream ⇐ stream.Writable
- new ParserStream(options)
- .document : ASTNode.<document>
- "script" (scriptElement, documentWrite(html), resume)

new ParserStream(options)

Streaming HTML parser with the scripting support. Writable stream.

Param	Type	Description
options	`ParserOptions`	Parsing options.

Example

var parse5 = require('parse5');
var http = require('http');

// Fetch google.com content and obtain it's <body> node
http.get('http://google.com', function(res) {
 var parser = new parse5.ParserStream();

 parser.on('finish', function() {
     var body = parser.document.childNodes[0].childNodes[1];
 });

 res.pipe(parser);
});

parserStream.document : `ASTNode.<document>`

Resulting document node.

Kind: instance property of ParserStream

"script" (scriptElement, documentWrite(html), resume)

Raised then parser encounters <script> element. If event has listeners then parsing will be suspended on event emission. So, if <script> has src attribute you can fetch it, execute and then resume parser like browsers do.

Kind: event emitted by ParserStream

Param	Type	Description
scriptElement	`ASTNode`	Script element that caused the event.
documentWrite(html)	`function`	Write additional `html` at the current parsing position. Suitable for the DOM `document.write` and `document.writeln` methods implementation.
resume	`function`	Resumes the parser.

Example

var parse = require('parse5');
var http = require('http');

var parser = new parse5.ParserStream();

parser.on('script', function(scriptElement, documentWrite, resume) {
  var src = parse5.treeAdapters.default.getAttrList(scriptElement)[0].value;

  http.get(src, function(res) {
     // Fetch script content, execute it with DOM built around `parser.document` and
     // `document.write` implemented using `documentWrite`
     ...
     // Then resume the parser
     resume();
  });
});

parser.end('<script src="example.com/script.js"></script>');

parse5.SerializerStream ⇐ `stream.Readable`

Kind: instance class of parse5
Extends: stream.Readable

new SerializerStream(node, [options])

Streaming AST node to HTML serializer. Readable stream.

Param	Type	Description
node	`ASTNode`	Node to serialize.
[options]	`SerializerOptions`	Serialization options.

Example

var parse5 = require('parse5');
var fs = require('fs');

var file = fs.createWriteStream('/home/index.html');

// Serialize parsed document to the HTML and write it to file
var document = parse5.parse('<body>Who is John Galt?</body>');
var serializer = new parse5.SerializerStream(document);

serializer.pipe(file);

parse5.SAXParser ⇐ `stream.Transform`

Kind: instance class of parse5
Extends: stream.Transform

.SAXParser ⇐ stream.Transform

new SAXParser(options)

Streaming SAX-style HTML parser. Transform stream (which means you can pipe through it, see example).

Param	Type	Description
options	`SAXParserOptions`	Parsing options.

Example

var parse5 = require('parse5');
var http = require('http');
var fs = require('fs');

var file = fs.createWriteStream('/home/google.com.html');
var parser = new SAXParser();

parser.on('text', function(text) {
 // Handle page text content
 ...
});

http.get('http://google.com', function(res) {
 // SAXParser is the Transform stream, which means you can pipe
 // through it. So you can analyze page content and e.g. save it
 // to the file at the same time:
 res.pipe(parser).pipe(file);
});