@nguniversal/express-engine
Advanced tools
This is an Express Engine for running Angular Apps on the server for server side rendering.
npm install @nguniversal/express-engine --save
To use it, set the engine and then route requests to it
import express from 'express';
import { ngExpressEngine } from '@nguniversal/express-engine';
const app = express();
// Set the engine
app.engine(
'html',
ngExpressEngine({
bootstrap: ServerAppModule, // Give it a module to bootstrap
}),
);
app.set('view engine', 'html');
app.get('/**/*', (req: Request, res: Response) => {
res.render('../dist/index', {
req,
res,
});
});
It is possible to override the default URL and document fetched when the rendering engine
is called. To do so, simply pass in a url and/or document string to the renderer as follows:
app.get('/**/*', (req: Request, res: Response) => {
let url = 'http://someurl.com';
let doc = '<html><head><title>New doc</title></head></html>';
res.render('../dist/index', {
req,
res,
url,
document: doc,
});
});
Extra Providers can be provided either on engine setup
app.engine(
'html',
ngExpressEngine({
bootstrap: ServerAppModule,
providers: [ServerService],
}),
);
The Bootstrap module as well as more providers can be passed on request
app.get('/**/*', (req: Request, res: Response) => {
res.render('../dist/index', {
req,
res,
bootstrap: OtherServerAppModule,
providers: [OtherServerService],
});
});
The Request and Response objects are injected into the app via injection tokens. You can access them by @Inject
import { Request } from 'express';
import { REQUEST } from '@nguniversal/express-engine/tokens';
@Injectable()
export class RequestService {
constructor(@Inject(REQUEST) private request: Request) {}
}
If your app runs on the client side too, you will have to provide your own versions of these in the client app.
You can also use a custom callback to better handle your errors
app.get('/**/*', (req: Request, res: Response) => {
res.render(
'../dist/index',
{
req,
res,
},
(err: Error, html: string) => {
res.status(html ? 200 : 500).send(html || err.message);
},
);
});
15.0.0 (2022-11-16)
14.[15-19].x and 16.[10-12].x. Current supported versions of Node.js are 14.20.x, 16.13.x and 18.10.x.appDir option was removed from the express-engine ng add schematic. This option was previously unused.| Commit | Type | Description |
| ------------------------------------------------------------------------------------------------ | -------- | --------------------------------------- |
| 6d5500d7 | fix | fix formatting in generated server.ts |
| 905c0ae1 | refactor | remove deprecated appDir option |
| Commit | Type | Description |
| ------------------------------------------------------------------------------------------------ | ---- | ---------------------------------------------- |
| fef00f90 | feat | add ng-server-context for SSG pages |
| 08979337 | feat | add sourcemap mapping support for dev-server |
| 654c23c8 | fix | import zone.js in worker during prerendering |
| Commit | Type | Description |
| ------------------------------------------------------------------------------------------------ | ---- | ------------------------------------- |
| a62d3d3b | feat | add ng-server-context for SSR pages |
| 78cf7b7f | feat | add support for Node.js version 18 |
Alan Agius, Carlos Torrecillas, Doug Parker, Greg Magolan and angular-robot[bot]
<!-- CHANGELOG SPLIT MARKER --><a name="14.2.1"></a>
FAQs
Express Engine for running Server Angular Apps
The npm package @nguniversal/express-engine receives a total of 66,778 weekly downloads. As such, @nguniversal/express-engine popularity was classified as popular.
We found that @nguniversal/express-engine demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."