@happy-dom/server-renderer

Use Happy DOM for server-side rendering (SSR) or static site generation (SSG).

The benefit of using this tool compared to other SSR and SSG solutions, is that it is not tied to a specific framework. For example, you can use React, Vue, Angular and Lit on the same page. The page is rendered as a whole and outputted as HTML.

This tool uses a worker pool by default to render multiple pages in parallel. Each worker can also render multiple pages in parallel that shares resources.

Installation

npm install @happy-dom/server-renderer --save-dev

Documentation

You will find the documentation in the Happy DOM Wiki under Server-Renderer.

Usage

Command Line

See all available command line arguments in the Command Line Documentation.

Note that JavaScript is disabled by default. To enable JavaScript, use the flag --javascript. A VM Context is not an isolated environment, and if you run untrusted JavaScript code you are at risk of RCE (Remote Code Execution) attacks. Read more about risks and recommended security precautions here.

Example 1

Render to the file ./happy-dom/render/gb/en/index.html.

npx @happy-dom/server-renderer --javascript "https://example.com/gb/en/"

or if you have it installed

happy-dom-sr --javascript "https://example.com/gb/en/"

Example 2

Start proxy server.

happy-dom-sr --javascript --server --server.targetOrigin="https://example.com"

JavaScript

See all available configuration options in the Javascript API Documentation.

Note that JavaScript is disabled by default. To enable JavaScript, set the configuration browser.enableJavaScriptEvaluation to true. A VM Context is not an isolated environment, and if you run untrusted JavaScript code you are at risk of RCE (Remote Code Execution) attacks. Read more about risks and recommended security precautions here.

Example 1

import { ServerRenderer } from '@happy-dom/server-renderer';

const renderer = new ServerRenderer({
   // Your configuration options
   browser: {
      enableJavaScriptEvaluation: true,
   },
});

const result = await renderer.render(['https://example.com/gb/en/']);

// URL of the rendered page
console.log(result[0].url);

// The rendered HTML
console.log(result[0].content);

Example 2

import { ServerRenderer } from '@happy-dom/server-renderer';

const renderer = new ServerRenderer({
   // Your configuration options
   browser: {
      enableJavaScriptEvaluation: true,
   },
});

const result = await renderer.render([{ url: 'https://example.com/gb/en/', html: '<div id="app"></div><script>document.getElementById("app").innerHTML = "Hello World!";</script>' }]);

// URL of the rendered page
console.log(result[0].url);

// The rendered HTML
console.log(result[0].content);

Happy DOM

Documentation | Getting Started | Setup as Test Environment | GitHub