{
  "id": "api/platform-server/PlatformConfig",
  "title": "PlatformConfig",
  "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/PlatformConfig\", \"name\": \"PlatformConfig\" } }\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/tokens.ts?message=docs(platform-server)%3A%20describe%20your%20change...#L10-L43\" 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/tokens.ts#L10-L43\" 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=\"platformconfig\">PlatformConfig<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server/PlatformConfig#platformconfig\"><i class=\"material-icons\">link</i></a></h1>\n    \n    <label class=\"api-type-label interface\">interface</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>Config object passed to initialize the platform.</p>\n\n    \n  </section>\n  \n  \n  <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/platform-server/PlatformConfig\" class=\"code-anchor\">PlatformConfig</a> {\n  <a class=\"code-anchor\" href=\"api/platform-server/PlatformConfig#document\"><span class=\"member-name\">document</span>?: string</a>\n  <a class=\"code-anchor\" href=\"api/platform-server/PlatformConfig#url\"><span class=\"member-name\">url</span>?: string</a>\n  <a class=\"code-anchor\" href=\"api/platform-server/PlatformConfig#useAbsoluteUrl\"><span class=\"member-name\">useAbsoluteUrl</span>?: boolean</a>\n  <a class=\"code-anchor\" href=\"api/platform-server/PlatformConfig#baseUrl\"><span class=\"member-name\">baseUrl</span>?: string</a>\n}\n</code-example>\n\n  \n  \n\n\n  \n  \n\n</section>\n\n  \n\n  \n  \n  \n<section class=\"instance-properties\">\n  <h2 id=\"properties\">Properties<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/platform-server/PlatformConfig#properties\"><i class=\"material-icons\">link</i></a></h2>\n  <table class=\"is-full-width list-table property-table\">\n    <thead>\n      <tr>\n        <th>Property</th>\n        <th>Description</th>\n      </tr>\n    </thead>\n    <tbody>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"document\"></a>\n          <code class=\"\"><span class=\"member-name\">document</span>?: string</code>\n        </td>\n        <td>\n          \n          <p>The initial DOM to use to bootstrap the server application.</p>\n\n          \n          </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"url\"></a>\n          <code class=\"\"><span class=\"member-name\">url</span>?: string</code>\n        </td>\n        <td>\n          \n          <p>The URL for the current application state. This is used for initializing\nthe platform's location. <code>protocol</code>, <code>hostname</code>, and <code>port</code> will be\noverridden if <code>baseUrl</code> is set.</p>\n\n          \n          </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"useAbsoluteUrl\"></a>\n          <code class=\"\"><span class=\"member-name\">useAbsoluteUrl</span>?: boolean</code>\n        </td>\n        <td>\n          \n          <p>Whether to append the absolute URL to any relative HTTP requests. If set to\ntrue, this logic executes prior to any HTTP interceptors that may run later\non in the request. <code>baseUrl</code> must be supplied if this flag is enabled.</p>\n\n          \n          </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"baseUrl\"></a>\n          <code class=\"\"><span class=\"member-name\">baseUrl</span>?: string</code>\n        </td>\n        <td>\n          \n          <p>The base URL for resolving absolute URL for HTTP requests. It must be set\nif <code>useAbsoluteUrl</code> is true, and must consist of protocol, hostname,\nand optional port. This option has no effect if <code>useAbsoluteUrl</code> is not\nenabled.</p>\n\n          \n          </td>\n    </tr>\n    \n    </tbody>\n  </table>\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/INITIAL_CONFIG\n-->\n<!-- links from this doc:\n - /api\n - api/platform-server\n - api/platform-server/PlatformConfig#baseUrl\n - api/platform-server/PlatformConfig#document\n - api/platform-server/PlatformConfig#platformconfig\n - api/platform-server/PlatformConfig#properties\n - api/platform-server/PlatformConfig#url\n - api/platform-server/PlatformConfig#useAbsoluteUrl\n - https://github.com/angular/angular/edit/master/packages/platform-server/src/tokens.ts?message=docs(platform-server)%3A%20describe%20your%20change...#L10-L43\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/platform-server/src/tokens.ts#L10-L43\n-->"
}