@angular/platform-server

Variables

• BEFORE_APP_SERIALIZED
• INITIAL_CONFIG
• ɵINTERNAL_SERVER_PLATFORM_PROVIDERS
• ɵSERVER_CONTEXT
• ɵSERVER_RENDER_PROVIDERS
• VERSION

Functions

• ɵsetDomTypes()
• platformDynamicServer()
• platformServer()
• renderApplication()
• renderModule()
• renderModuleFactory()

Classes

• ɵServerRendererFactory2

  • begin()
  • createRenderer()
  • end()
  • ɵfac
  • ɵprov
• PlatformState

  • getDocument()
  • ɵfac
  • ɵprov
  • renderToString()
• ServerModule

  • ɵfac
  • ɵinj
  • ɵmod
• ServerTransferStateModule

  • ɵfac
  • ɵinj
  • ɵmod

Interfaces

• PlatformConfig

  • baseUrl
  • document
  • url
  • useAbsoluteUrl

variable BEFORE_APP_SERIALIZED

const BEFORE_APP_SERIALIZED: InjectionToken<(() => void | Promise<void>)[]>;

• A function that will be executed when calling renderApplication, renderModuleFactory or renderModule just before current platform state is rendered to string.

variable INITIAL_CONFIG

const INITIAL_CONFIG: InjectionToken<PlatformConfig>;

• The DI token for setting the initial config for the platform.

variable ɵINTERNAL_SERVER_PLATFORM_PROVIDERS

const ɵINTERNAL_SERVER_PLATFORM_PROVIDERS: StaticProvider[];

variable ɵSERVER_CONTEXT

const ɵSERVER_CONTEXT: InjectionToken<string>;

• An internal token that allows providing extra information about the server context (e.g. whether SSR or SSG was used). The value is a string and characters other than [a-zA-Z0-9-] are removed. See the default value in DEFAULT_SERVER_CONTEXT const.

variable ɵSERVER_RENDER_PROVIDERS

const ɵSERVER_RENDER_PROVIDERS: Provider[];

variable VERSION

const VERSION: Version;

function ɵsetDomTypes

ɵsetDomTypes: () => void;

function platformDynamicServer

platformDynamicServer: (
    extraProviders?: StaticProvider[] | undefined
) => PlatformRef;

• The server platform that supports the runtime compiler.

function platformServer

platformServer: (extraProviders?: StaticProvider[] | undefined) => PlatformRef;

function renderApplication

renderApplication: <T>(
    rootComponent: Type<T>,
    options: {
        appId: string;
        document?: string | Document;
        url?: string;
        providers?: Array<Provider | EnvironmentProviders>;
        platformProviders?: Provider[];
    }
) => Promise<string>;

• Bootstraps an instance of an Angular application and renders it to a string.

  Note: the root component passed into this function *must* be a standalone one (should have the standalone: true flag in the @Component decorator config).

  @Component({
    standalone: true,
    template: 'Hello world!'
  })
  class RootComponent {}
  
  const output: string = await renderApplication(RootComponent, {appId: 'server-app'});

  Parameter rootComponent

  A reference to a Standalone Component that should be rendered.

  Parameter options

  Additional configuration for the render operation: - appId - a string identifier of this application. The appId is used to prefix all server-generated stylings and state keys of the application in TransferState use-cases. - document - the document of the page to render, either as an HTML string or as a reference to the document instance. - url - the URL for the current render request. - providers - set of application level providers for the current render request. - platformProviders - the platform level providers for the current render request.

  Returns

  A Promise, that returns serialized (to a string) rendered page, once resolved.

function renderModule

renderModule: <T>(
    moduleType: Type<T>,
    options: {
        document?: string | Document;
        url?: string;
        extraProviders?: StaticProvider[];
    }
) => Promise<string>;

• Bootstraps an application using provided NgModule and serializes the page content to string.

  Parameter moduleType

  A reference to an NgModule that should be used for bootstrap.

  Parameter options

  Additional configuration for the render operation: - document - the document of the page to render, either as an HTML string or as a reference to the document instance. - url - the URL for the current render request. - extraProviders - set of platform level providers for the current render request.

function renderModuleFactory

renderModuleFactory: <T>(
    moduleFactory: NgModuleFactory<T>,
    options: { document?: string; url?: string; extraProviders?: StaticProvider[] }
) => Promise<string>;

• Bootstraps an application using provided NgModuleFactory and serializes the page content to string.

  Parameter moduleFactory

  An instance of the NgModuleFactory that should be used for bootstrap.

  Parameter options

  Additional configuration for the render operation: - document - the document of the page to render, either as an HTML string or as a reference to the document instance. - url - the URL for the current render request. - extraProviders - set of platform level providers for the current render request.

  Deprecated

  This symbol is no longer necessary as of Angular v13. Use renderModule API instead.