5 lines
44 KiB
JSON
5 lines
44 KiB
JSON
{
|
|
"id": "api/platform-server/renderModule",
|
|
"title": "renderModule",
|
|
"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 { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/platform-server/renderModule\", \"name\": \"renderModule\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/platform-server\">@angular/platform-server</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/platform-server/src/utils.ts?message=docs(platform-server)%3A%20describe%20your%20change...#L88-L108\" 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/src/utils.ts#L88-L108\" 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=\"rendermodule\">renderModule<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server/renderModule#rendermodule\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label function\">function</label>\n \n \n \n </header>\n \n <aio-toc class=\"embedded\"></aio-toc>\n\n <div class=\"api-body\">\n \n <section class=\"short-description\">\n <p>Renders a Module to string.</p>\n\n <p><a href=\"api/platform-server/renderModule#description\">See more...</a></p>\n </section>\n \n \n \n\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"> <span class=\"member-name\"><a href=\"api/platform-server/renderModule\" class=\"code-anchor\">renderModule</a></span><T>(module: <a href=\"api/core/Type\" class=\"code-anchor\">Type</a><T>, options: { document?: string; url?: string; extraProviders?: <a href=\"api/core/StaticProvider\" class=\"code-anchor\">StaticProvider</a>[]; }): Promise<string></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table function-overload-parameters\">\n <tbody>\n \n <tr class=\"function-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>module</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/core/Type\" class=\"code-anchor\">Type</a><t></t></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"function-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>Promise<string></code></p>\n\n \n\n\n \n\n \n</div>\n\n\n \n\n \n\n<section class=\"description\">\n <h2 id=\"description\">Description<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server/renderModule#description\"><i class=\"material-icons\">link</i></a></h2>\n <p><code>document</code> is the full document HTML of the page to render, as a string.\n<code>url</code> is the URL for the current render request.\n<code>extraProviders</code> are the platform level providers for the current render request.</p>\n<p>If compiling with the ViewEngine renderer, do not use this in a production server environment.\nUse pre-compiled <a href=\"api/core/NgModuleFactory\"><code>NgModuleFactory</code></a> with <a href=\"api/platform-server/renderModuleFactory\"><code>renderModuleFactory</code></a> instead. If\ncompiling with the Ivy renderer, this method is the recommended rendering method for\nplatform-server.</p>\n\n \n</section>\n\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/platform-server\n - api/platform-server/BEFORE_APP_SERIALIZED\n - guide/universal\n-->\n<!-- links from this doc:\n - /api\n - api/core/NgModuleFactory\n - api/core/StaticProvider\n - api/core/Type\n - api/platform-server\n - api/platform-server/renderModule#description\n - api/platform-server/renderModule#rendermodule\n - api/platform-server/renderModuleFactory\n - https://github.com/angular/angular/edit/master/packages/platform-server/src/utils.ts?message=docs(platform-server)%3A%20describe%20your%20change...#L88-L108\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-server/src/utils.ts#L88-L108\n-->"
|
|
} |