The vdom-streaming-serializer is a library for serializing virtual DOM objects into chunks of strings that can be written into an HTTP response.
npm install vdom-streaming-serializer
A virtual dom has to be created and running the serialization will emit chunks of HTML.
This example creates a virtual dom and serializes it to emit streams of HTML elements in Chunks.
var document = makeDocument();
var ul = document.createElement('ul');
document.body.appendChild(ul);
var li = document.createElement('li');Making this <li> as asynchronous will force the serialize to wait.
var ASYNC = Symbol.for('async-node');
li[ASYNC] = Promise.resolve();
ul.appendChild(li);Once the element is serialized, it is then emitted in data event.
var stream = serialize(document);
stream.setEncoding('utf8');
stream.on('data', function(html){
console.log('Chunk', html);
});The output from this demo should be:
Chunk <html><body><ul>
Chunk <li></li></ul<body></html>
From this, the <li> element is serialized asynchronously.
The serialization process traverses and checks for html syntax and attributes to add to the buffer.
Upon noticing a child node, the serializer determines whether its child is asynchronous or not. If it is, the current buffer is flushed and the element begins serializing the asynchronous child.
It handles synchronous and asynchronous elements differently by resolving promise elements if we wish to wait before emitting.
MIT