2021-06-28 19:54:20 +02:00
|
|
|
## API Report File for "@angular/platform-server"
|
|
|
|
|
|
|
|
|
|
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
|
|
|
|
|
|
|
|
```ts
|
|
|
|
|
|
2023-02-28 11:43:35 +00:00
|
|
|
import { ApplicationRef } from '@angular/core';
|
2025-09-08 09:27:03 +00:00
|
|
|
import { BootstrapContext } from '@angular/platform-browser';
|
2022-10-05 12:14:41 -07:00
|
|
|
import { EnvironmentProviders } from '@angular/core';
|
2021-09-19 20:38:34 +02:00
|
|
|
import * as i0 from '@angular/core';
|
2025-01-28 18:11:22 +01:00
|
|
|
import * as i1 from '@angular/platform-browser';
|
2021-06-28 19:54:20 +02:00
|
|
|
import { InjectionToken } from '@angular/core';
|
|
|
|
|
import { PlatformRef } from '@angular/core';
|
2022-04-26 19:34:19 -07:00
|
|
|
import { Provider } from '@angular/core';
|
2021-06-28 19:54:20 +02:00
|
|
|
import { StaticProvider } from '@angular/core';
|
|
|
|
|
import { Type } from '@angular/core';
|
|
|
|
|
import { Version } from '@angular/core';
|
|
|
|
|
|
|
|
|
|
// @public
|
2023-07-20 10:04:41 -07:00
|
|
|
export const BEFORE_APP_SERIALIZED: InjectionToken<readonly (() => void | Promise<void>)[]>;
|
2021-06-28 19:54:20 +02:00
|
|
|
|
|
|
|
|
// @public
|
|
|
|
|
export const INITIAL_CONFIG: InjectionToken<PlatformConfig>;
|
|
|
|
|
|
|
|
|
|
// @public
|
|
|
|
|
export interface PlatformConfig {
|
|
|
|
|
document?: string;
|
|
|
|
|
url?: string;
|
|
|
|
|
}
|
|
|
|
|
|
2025-09-08 09:27:03 +00:00
|
|
|
// @public
|
2024-10-29 12:22:55 +00:00
|
|
|
export function platformServer(extraProviders?: StaticProvider[] | undefined): PlatformRef;
|
2021-06-28 19:54:20 +02:00
|
|
|
|
|
|
|
|
// @public
|
|
|
|
|
export class PlatformState {
|
|
|
|
|
constructor(_doc: any);
|
|
|
|
|
getDocument(): any;
|
|
|
|
|
renderToString(): string;
|
2021-09-19 20:38:34 +02:00
|
|
|
// (undocumented)
|
|
|
|
|
static ɵfac: i0.ɵɵFactoryDeclaration<PlatformState, never>;
|
|
|
|
|
// (undocumented)
|
|
|
|
|
static ɵprov: i0.ɵɵInjectableDeclaration<PlatformState>;
|
2021-06-28 19:54:20 +02:00
|
|
|
}
|
|
|
|
|
|
2023-03-09 14:11:40 +00:00
|
|
|
// @public
|
2026-05-26 10:27:25 +02:00
|
|
|
export function provideServerRendering(options?: {
|
|
|
|
|
maxResponseBodySize: number;
|
|
|
|
|
}): EnvironmentProviders;
|
2023-03-09 14:11:40 +00:00
|
|
|
|
2023-02-28 11:43:35 +00:00
|
|
|
// @public
|
2025-09-08 09:27:03 +00:00
|
|
|
export function renderApplication(bootstrap: (context: BootstrapContext) => Promise<ApplicationRef>, options: {
|
2023-02-28 11:43:35 +00:00
|
|
|
document?: string | Document;
|
|
|
|
|
url?: string;
|
|
|
|
|
platformProviders?: Provider[];
|
2026-05-05 09:49:18 +00:00
|
|
|
allowedHosts?: Readonly<string>[];
|
2023-02-28 11:43:35 +00:00
|
|
|
}): Promise<string>;
|
|
|
|
|
|
2021-06-28 19:54:20 +02:00
|
|
|
// @public
|
2022-08-09 17:25:23 -07:00
|
|
|
export function renderModule<T>(moduleType: Type<T>, options: {
|
2022-08-03 14:19:40 -07:00
|
|
|
document?: string | Document;
|
2021-06-28 19:54:20 +02:00
|
|
|
url?: string;
|
|
|
|
|
extraProviders?: StaticProvider[];
|
2026-05-05 09:49:18 +00:00
|
|
|
allowedHosts?: Readonly<string>[];
|
2021-06-28 19:54:20 +02:00
|
|
|
}): Promise<string>;
|
|
|
|
|
|
2026-06-05 10:03:20 +00:00
|
|
|
// @public
|
|
|
|
|
export const enum RuntimeErrorCode {
|
|
|
|
|
// (undocumented)
|
|
|
|
|
DISABLED_DOM_EMULATION_IN_NON_BROWSER = 5704,
|
|
|
|
|
// (undocumented)
|
|
|
|
|
GET_COOKIE_NOT_IMPLEMENTED = 5700,
|
|
|
|
|
// (undocumented)
|
|
|
|
|
HOST_NOT_ALLOWED = 5706,
|
|
|
|
|
// (undocumented)
|
|
|
|
|
INVALID_URL = 5701,
|
|
|
|
|
// (undocumented)
|
|
|
|
|
PROTOCOL_RELATIVE_URL_NOT_ALLOWED = 5702,
|
|
|
|
|
// (undocumented)
|
|
|
|
|
SUSPICIOUS_URL_CHANGE_ORIGIN = 5703,
|
|
|
|
|
// (undocumented)
|
|
|
|
|
XHR_NOT_LOADED = 5705
|
|
|
|
|
}
|
|
|
|
|
|
2021-06-28 19:54:20 +02:00
|
|
|
// @public
|
|
|
|
|
export class ServerModule {
|
2021-09-19 20:38:34 +02:00
|
|
|
// (undocumented)
|
|
|
|
|
static ɵfac: i0.ɵɵFactoryDeclaration<ServerModule, never>;
|
|
|
|
|
// (undocumented)
|
|
|
|
|
static ɵinj: i0.ɵɵInjectorDeclaration<ServerModule>;
|
|
|
|
|
// (undocumented)
|
2025-01-28 18:11:22 +01:00
|
|
|
static ɵmod: i0.ɵɵNgModuleDeclaration<ServerModule, never, never, [typeof i1.BrowserModule]>;
|
2021-06-28 19:54:20 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// @public (undocumented)
|
|
|
|
|
export const VERSION: Version;
|
|
|
|
|
|
|
|
|
|
// (No @packageDocumentation comment for this package)
|
|
|
|
|
|
|
|
|
|
```
|