simple-ssr
v2.2.0
Published
Universal server-side rendering implementation for Node.js
Downloads
15
Maintainers
kirlovonReadme
What is it?
Universal server-side rendering implementation for Node.js. Powered by Puppeteer. This library allows you to preload your web applications on the server side, and send rendered data to the user.
In simple terms, this module translates this:
<div id="app"></div>
<script>
document.getElementById('app').innerHTML = 'Hello, world!';
</script>To this:
<div id="app">Hello, world!</div>
<script>
document.getElementById('app').innerHTML = 'Hello, world!';
</script>Note: The minimum supported Node version is Node 7.x
Features
- Simplifies crawlers work with your Single Page Applications or Progressive Web Apps.
- Allows you to cache data, optimizing the server-side rendering process.
- Preload your web applications on the server-side.
- TypeScript support.
Installation
Installation from the NPM repository:
npm install simple-ssr --saveExample
const simpleSSR = require('simple-ssr');
// Puppeteer instance
simpleSSR.browser;
// Enable requests filtering ( Default: true )
simpleSSR.filterRequests = true;
// List of useless for DOM rendering resources
simpleSSR.blockedRequest = ['stylesheet', 'image'];
(async() => {
// Put there Puppeteer config
await simpleSSR.start({ headless: true });
let result = await simpleSSR.render('http://example.com/', {
// Rendering timeout
timeout: 1000,
// When to consider navigation succeeded.
waitUntil: 'load',
// DOM target to wait for
domTarget: ['body', 'h1']
});
console.log(result.url) // 'http://example.com/'
console.log(result.time) // 10000
console.log(result.html) // '<!DOCTYPE html>...'
})();