{
  "id": "api/platform-server",
  "title": "@angular/platform-server",
  "contents": "\n\n<article>\n  <div class=\"breadcrumb-container\">\n    <div class=\"breadcrumb\">\n      <script type=\"application/ld+json\">\n        {\n          \"@context\": \"http://schema.org\",\n          \"@type\": \"BreadcrumbList\",\n          \"itemListElement\": [\n            { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io//api\", \"name\": \"API\" } },\n            { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/platform-server\", \"name\": \"@angular/platform-server\" } }\n          ]\n        }\n      </script>\n        <a href=\"/api\">API</a>\n    </div>\n    <div class=\"github-links\">\n  <a href=\"https://github.com/angular/angular/edit/master/packages/platform-server/PACKAGE.md?message=docs(...)%3A%20describe%20your%20change...\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n  <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-server/PACKAGE.md\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n  </div>\n  \n<header class=\"api-header\">\n  <h1 id=\"angularplatform-server\">@angular/platform-server<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server#angularplatform-server\"><i class=\"material-icons\">link</i></a></h1>\n  <label class=\"api-type-label package\">package</label>\n  \n  \n  \n</header>\n\n  <aio-toc class=\"embedded\"></aio-toc>\n\n  <div class=\"api-body\">\n    <p>Supports delivery of Angular apps on a server, for use with <a href=\"guide/glossary#server-side-rendering\">server-side rendering</a> (SSR).</p>\n\n  <p>For more information, see <a href=\"guide/universal\">Server-side Rendering: An intro to Angular Universal</a>.</p>\n\n\n  \n\n\n  \n  <h2 id=\"entry-points\">Entry points<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server#entry-points\"><i class=\"material-icons\">link</i></a></h2>\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"primary\">Primary<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server#primary\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/platform-server#primary-entry-point-exports\">@angular/platform-server</a></code></td>\n        <td>\n          \n          <p>Supports delivery of Angular apps on a server, for use with <a href=\"guide/glossary#server-side-rendering\">server-side rendering</a> (SSR).</p>\n\n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"secondary\">Secondary<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server#secondary\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/platform-server/init\">@angular/platform-server/init</a></code></td>\n        <td>\n          \n          <p>Initializes the server environment for rendering an Angular application.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/platform-server/testing\">@angular/platform-server/testing</a></code></td>\n        <td>\n          \n          <p>Supplies a testing module for the Angular platform server subsystem.</p>\n\n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n\n  <h2 id=\"primary-entry-point-exports\">Primary entry point exports<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server#primary-entry-point-exports\"><i class=\"material-icons\">link</i></a></h2>\n  \n  \n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"ngmodules\">NgModules<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server#ngmodules\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/platform-server/ServerModule\">ServerModule</a></code></td>\n        <td>\n          \n          <p>The ng module for the server.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/platform-server/ServerTransferStateModule\">ServerTransferStateModule</a></code></td>\n        <td>\n          \n          <p>NgModule to install on the server side while using the <code><a href=\"api/platform-browser/TransferState\" class=\"code-anchor\">TransferState</a></code> to transfer state from\nserver to client.</p>\n\n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"classes\">Classes<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server#classes\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/platform-server/PlatformState\">PlatformState</a></code></td>\n        <td>\n          \n          <p>Representation of the current platform state.</p>\n\n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"functions\">Functions<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server#functions\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/platform-server/renderModule\">renderModule</a></code></td>\n        <td>\n          \n          <p>Renders a Module to string.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/platform-server/renderModuleFactory\">renderModuleFactory</a></code></td>\n        <td>\n          \n          <p>Renders a <a href=\"api/core/NgModuleFactory\"><code>NgModuleFactory</code></a> to string.</p>\n\n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"structures\">Structures<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server#structures\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/platform-server/PlatformConfig\">PlatformConfig</a></code></td>\n        <td>\n          \n          <p>Config object passed to initialize the platform.</p>\n\n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n\n  \n  \n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"types\">Types<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server#types\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/platform-server/BEFORE_APP_SERIALIZED\">BEFORE_APP_SERIALIZED</a></code></td>\n        <td>\n          \n          <p>A function that will be executed when calling <code><a href=\"api/platform-server/renderModuleFactory\" class=\"code-anchor\">renderModuleFactory</a></code> or <code><a href=\"api/platform-server/renderModule\" class=\"code-anchor\">renderModule</a></code> just\nbefore current platform state is rendered to string.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/platform-server/INITIAL_CONFIG\">INITIAL_CONFIG</a></code></td>\n        <td>\n          \n          <p>The DI token for setting the initial config for the platform.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/platform-server/platformDynamicServer\">platformDynamicServer</a></code></td>\n        <td>\n          \n          <p>The server platform that supports the runtime compiler.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/platform-server/platformServer\">platformServer</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/platform-server/BEFORE_APP_SERIALIZED\n - api/platform-server/INITIAL_CONFIG\n - api/platform-server/PlatformConfig\n - api/platform-server/PlatformState\n - api/platform-server/ServerModule\n - api/platform-server/ServerTransferStateModule\n - api/platform-server/init\n - api/platform-server/platformDynamicServer\n - api/platform-server/platformServer\n - api/platform-server/renderModule\n - api/platform-server/renderModuleFactory\n - api/platform-server/testing\n - api/platform-server/testing/ServerTestingModule\n - api/platform-server/testing/platformServerTesting\n - guide/glossary\n-->\n<!-- links from this doc:\n - /api\n - api/core/NgModuleFactory\n - api/platform-browser/TransferState\n - api/platform-server#angularplatform-server\n - api/platform-server#classes\n - api/platform-server#entry-points\n - api/platform-server#functions\n - api/platform-server#ngmodules\n - api/platform-server#primary\n - api/platform-server#primary-entry-point-exports\n - api/platform-server#secondary\n - api/platform-server#structures\n - api/platform-server#types\n - api/platform-server/BEFORE_APP_SERIALIZED\n - api/platform-server/INITIAL_CONFIG\n - api/platform-server/PlatformConfig\n - api/platform-server/PlatformState\n - api/platform-server/ServerModule\n - api/platform-server/ServerTransferStateModule\n - api/platform-server/init\n - api/platform-server/platformDynamicServer\n - api/platform-server/platformServer\n - api/platform-server/renderModule\n - api/platform-server/renderModuleFactory\n - api/platform-server/testing\n - guide/glossary#server-side-rendering\n - guide/universal\n - https://github.com/angular/angular/edit/master/packages/platform-server/PACKAGE.md?message=docs(...)%3A%20describe%20your%20change...\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-server/PACKAGE.md\n-->"
}