Server-Side Rendering (SSR) Support

• 1. Overview
• 2. Prerequisites
• 3. Required Server Build Configuration

1. Overview

The NGX-PFE library is safe to run as a Angular SSR (Server-Side Rendering) application or prerendering context. However, one additional build configuration step is required in consuming applications that enable SSR, this page documents that step.

2. Prerequisites

This guide assumes your app already has Angular SSR set up, e.g. via:

ng add @angular/ssr

or, in an Nx workspace:

nx g @nx/angular:setup-ssr --project=<your-app>

3. Required Server Build Configuration

If your app does SSR or prerendering, you must mark jsonpath and esprima as external dependencies in your server build target.

If you're using the webpack-based @angular-devkit/build-angular:server builder (project.json in an Nx workspace, or angular.json in a plain Angular CLI project), add this to the server target's options:

{
  "server": {
    "executor": "@angular-devkit/build-angular:server",
    "options": {
      "externalDependencies": ["jsonpath", "esprima"]
    }
  }
}

If you're using the newer application builder, there's no separate server target. Add externalDependencies to the build target's options directly:

{
  "build": {
    "executor": "@angular-devkit/build-angular:application",
    "options": {
      "externalDependencies": ["jsonpath", "esprima"]
    }
  }
}

⚠️ IMPORTANT: Without this setting, the app will fail at runtime with an error similar to Error: EBADF: bad file descriptor, fstat.