A progressive Node.js framework for building efficient and scalable server-side applications.
\n
\n\n\n\n\n\n\n\n\n\n \n \n
\n \n\n## Description\n\nAngular [Universal](https://github.com/angular/universal) module for [Nest](https://github.com/nestjs/nest).\n\n## Installation\n\nUsing the Angular CLI:\n\n```bash\n$ ng add @nestjs/ng-universal\n```\n\nOr manually:\n\n```bash\n$ npm i @nestjs/ng-universal\n```\n\n## Example\n\nSee full example [here](https://github.com/kamilmysliwiec/universal-nest).\n\n## Usage\n\nIf you have installed the module manually, you need to import `AngularUniversalModule` in your Nest application.\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { join } from 'path';\nimport { AngularUniversalModule } from '@nestjs/ng-universal';\n\n@Module({\n imports: [\n AngularUniversalModule.forRoot({\n bootstrap: AppServerModule,\n viewsPath: join(process.cwd(), 'dist/{APP_NAME}/browser')\n })\n ]\n})\nexport class ApplicationModule {}\n```\n\n## API Spec\n\nThe `forRoot()` method takes an options object with a few useful properties.\n\n| Property | Type | Description |\n| ------------------- | ------------------- | -------------------------------------------------------------------------- |\n| `viewsPath` | string | The directory where the module should look for client bundle (Angular app) |\n| `bootstrap` | Function | Angular server module reference (`AppServerModule`). |\n| `templatePath` | string? | Path to index file (default: `{viewsPaths}/index.html`) |\n| `rootStaticPath` | string? | Static files root directory (default: `*.*`) |\n| `renderPath` | string? | Path to render Angular app (default: `*`) |\n| `extraProviders` | StaticProvider[]? | The platform level providers for the current render request |\n| `inlineCriticalCss` | boolean? | Reduce render blocking requests by inlining critical CSS. (default: true) |\n| `cache` | boolean? \\| object? | Cache options, description below (default: `true`) |\n| `errorHandler` | Function? | Callback to be called in case of a rendering error |\n\n### Cache\n\n| Property | Type | Description |\n| -------------- | ------------------ | ------------------------------------------------------------------------------ |\n| `expiresIn` | number? | Cache expiration in milliseconds (default: `60000`) |\n| `storage` | CacheStorage? | Interface for implementing custom cache storage (default: in memory) |\n| `keyGenerator` | CacheKeyGenerator? | Interface for implementing custom cache key generation logic (default: by url) |\n\n```typescript\nAngularUniversalModule.forRoot({\n bootstrap: AppServerModule,\n viewsPath: join(process.cwd(), 'dist/{APP_NAME}/browser'),\n cache: {\n storage: {\n useValue: new InMemoryCacheStorage(),\n // or\n // useClass: RedisCacheStorage,\n },\n expiresIn: DEFAULT_CACHE_EXPIRATION_TIME,\n keyGenerator: new CustomCacheKeyGenerator()\n }\n});\n```\n\n### Example for CacheKeyGenerator:\n\n```typescript\nexport class CustomCacheKeyGenerator implements CacheKeyGenerator {\n generateCacheKey(request: Request): string {\n const md = new MobileDetect(request.headers['user-agent']);\n const isMobile = md.mobile() ? 'mobile' : 'desktop';\n return (request.hostname + request.originalUrl + isMobile).toLowerCase();\n }\n}\n```\n\n## Request and Response Providers\n\nThis tool uses `@nguniversal/express-engine` and will properly provide access to the Express Request and Response objects in you Angular components. Note that tokens must be imported from the `@nestjs/ng-universal/tokens`, not `@nguniversal/express-engine/tokens`.\n\nThis is useful for things like setting the response code to 404 when your Angular router can't find a page (i.e. `path: '**'` in routing):\n\n```ts\nimport { Response } from 'express';\nimport { Component, Inject, Optional, PLATFORM_ID } from '@angular/core';\nimport { isPlatformServer } from '@angular/common';\nimport { RESPONSE } from '@nestjs/ng-universal/tokens';\n\n@Component({\n selector: 'my-not-found',\n templateUrl: './not-found.component.html',\n styleUrls: ['./not-found.component.scss']\n})\nexport class NotFoundComponent {\n constructor(\n @Inject(PLATFORM_ID)\n private readonly platformId: any,\n @Optional()\n @Inject(RESPONSE)\n res: Response\n ) {\n // `res` is the express response, only available on the server\n if (isPlatformServer(this.platformId)) {\n res.status(404);\n }\n }\n}\n```\n\n## Custom Webpack\n\nIn some situations, it may be required to customize the `webpack` build while using `@nestjs/ng-universal`, especially when additional dependencies are included (that rely on native Node.js code).\n\nTo add a customizable `webpack` config to your project, it is recommended to install [@angular-builders/custom-webpack](https://www.npmjs.com/package/@angular-builders/custom-webpack) in the project and to set your builders appropriately.\n\n### Example Custom Webpack\n```typescript\n// webpack.config.ts\nimport { Configuration, IgnorePlugin } from 'webpack'\nimport {\n CustomWebpackBrowserSchema,\n TargetOptions\n} from '@angular-builders/custom-webpack'\nimport nodeExternals from 'webpack-node-externals'\n\nexport default (\n config: Configuration\n _options: CustomWebpackBrowserSchema,\n targetOptions: TargetOptions\n) => {\n if (targetOptions.target === 'server') {\n config.resolve?.extensions?.push('.mjs', '.graphql', '.gql')\n\n config.module?.rules?.push({\n test: /\\.mjs$/,\n include: /node_modules/,\n type: 'javascript/auto'\n });\n\n config.externalsPresets = { node: true }\n\n (config.externals as Array).push(\n nodeExternals({ allowlist: [/^(?!(livereload|concurrently|fsevents)).*/]})\n );\n\n config.plugins?.push(\n new IgnorePlugin({\n checkResource: (resource: string) => {\n const lazyImports = [\n '@nestjs/microservices',\n '@nestjs/microservices/microservices-module',\n '@nestjs/websockets/socket-module',\n 'cache-manager',\n 'class-validator',\n 'class-transform',\n ];\n\n if (!lazyImpots.includes(resource)) {\n return false;\n }\n\n try {\n require.resolve(resource)\n } catch (_err: any) {\n return true;\n }\n return false;\n }\n })\n );\n }\n return config;\n};\n\n```\n\n## Support\n\nNest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).\n\n## Stay in touch\n\n- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)\n- Website - [https://nestjs.com](https://nestjs.com/)\n- Twitter - [@nestframework](https://twitter.com/nestframework)\n\n## License\n\nNest is [MIT licensed](LICENSE).\n","readmeFilename":"README.md"}
![\"Nest](\"https://nestjs.com/img/logo_text.svg\"){kind=logo}
\n![\"NPM](\"https://img.shields.io/npm/v/@nestjs/core.svg\")
\n![\"Package](\"https://img.shields.io/npm/l/@nestjs/core.svg\")
\n![\"NPM](\"https://img.shields.io/npm/dm/@nestjs/core.svg\")
\n![\"Travis\"](\"https://api.travis-ci.org/nestjs/nest.svg?branch=master\")
\n![\"Linux\"](\"https://img.shields.io/travis/nestjs/nest/master.svg?label=linux\")
\n![\"Coverage\"](\"https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#5\"){kind=icon}
\n![\"Discord\"/](\"https://img.shields.io/badge/discord-online-brightgreen.svg\"){kind=icon}
\n![\"Backers](\"https://opencollective.com/nest/backers/badge.svg\"){kind=icon}
\n![\"Sponsors](\"https://opencollective.com/nest/sponsors/badge.svg\"){kind=icon}
\n ![](\"https://img.shields.io/badge/Donate-PayPal-dc3d53.svg\"/){kind=icon}
\n ![](\"https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow\")
\n