API

[matthewp]

The API for vdom-streaming-serializer is:

signature

serialize(element) -> stream

In context of a web server it will look like:

var http = require('http');
var makeDocument = require('can-vdom/make-document/make-document');
var serialize = require('vdom-streaming-serializer');

http.createServer(function(request, response){

  var document = makeDocument();
  var h1 = document.createElement('h1');
  h1.appendChild(document.createTextNode('Hello world!'));

  document.body.appendChild(h1);

  var stream = serialize(document.documentElement);
  stream.pipe(response);

});

Parameters

• element is any DOM Node. In practice this will be a documentElement created with can-simple-dom.

var makeDocument = require('can-vdom/make-document/make-document');
var serialize = require('vdom-streaming-serializer');

var document = makeDocument();
serialize(document.documentElement);

Returns

• A Node.js ReadableStream object. This stream can then be piped into an HTTP response object:

var stream = serialize(document.documentElement);
stream.pipe(response);