@nguniversal/express-engine NPM | npm.io

16.2.0 • Published 2 years ago

Install

Weekly downloads

119,442

License

MIT

Repository

Last release

2 years ago

Angular Express Engine

This is an Express Engine for running Angular Apps on the server for server side rendering.

Usage

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,
  });
});

Configuring the URL and Document

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

Extra Providers can be provided either on engine setup

app.engine(
  'html',
  ngExpressEngine({
    bootstrap: ServerAppModule,
    providers: [ServerService],
  }),
);

Advanced Usage

Request based Bootstrap

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],
  });
});

Using the Request and Response

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.

Using a Custom Callback

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);
    },
  );
});

express ssr universal

@nguniversal/common tslib

@ljmarquezge2y/worldpay-spartacus laji-front planner-project coderbase-monorepo-librairie ten-thousand ng-wc-frontend ohayojp nebular-angular-seed ngpacab-shared-imi-v124 bnqczz_delon yelon @happystagger/web @davidlj95/website @davidlj95/website-v2 angular2-multiselect-dropdown-oe @everything-registry/sub-chunk-648 @spvcoder/ng-universal @spvcoder/ng-universal-next tbsoft.appserver test-angular-elastic-ui winter-ng-universal-plugin tematikbagis vmdkmks victop-front-end-frame @coraledge/nx-serverless @rucken/core iwe10 @pib_tech/common spa-shared-lib @arsloptima/password-strength @cdutils/apptoolkit @daybreaksoft/angular-elastic-ui @meteora-pro/nestjs-ng-universal-async-cache @netlify/plugin-angular-universal @nestjs/ng-universal @ng-toolkit/universal @nhammond101/nx-serverless @engineers/ngx-universal-express @house-of-angular/nestjs-ng-pdf-generator @hmcts/annotation-ui @kai1015/application @kai1015/frontend-sls-deploy @kerr-srl/ngx-cookie @pixelmatic/blog @nxarch/nest-nguniversal @spielhalle/client @spartacus/fsa-schematics @spartacus/schematics @spartacus/setup omni-check nx-serverless-re ohayolibs pc-package search-users pyge senz-ssp node-angular-app-template ng-universal-15 nguniversal-expressengine-httpinterceptor ngx-fire-cookie ng-abtest ng-ssr ngext ngpacab-shared-imi-v142 ngx-cookie-ggy notationpwa pp2 r-app1 shared-encoding-library gnw-compliance-checker-rules ghost-express-server imeepos-framework incognito-ssp ham-app-universal localize-router-ssr kre-form @waitaction/nestjs-ng-universal @verdocs/angular-api @verdocs/search @valueadd/nestjs-ng-pdf-generator @worldpay2020/spartacus @typijs/core @tolstenko/ng-universal @terragon/terragon @zalastax/nolb-_ngu angular-ab-tests angular-nest-starter angular-ssr-startup animate-on-scroll-sample-project angular-plugin-architecture asi-ngtools-app cap-angular-schematic-ssr delon-fork fe-angular-global fm-radio flowaccount @shumih/ng-universal gdti-crm fusebox-angular-universal-starter fusing-angular

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

0.0.0-PLACEHOLDER

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago

7.0.0-rc.1.with-local-changes

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago