@angular/platform-server

  • Version 15.0.1
  • Published
  • 455 kB
  • 3 dependencies
  • MIT license

Install

npm i @angular/platform-server
yarn add @angular/platform-server
pnpm add @angular/platform-server

Overview

Angular - library for using Angular in Node.js

Index

Variables

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;

      Functions

      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.

        Classes

        class ɵServerRendererFactory2

        class ɵServerRendererFactory2 implements RendererFactory2 {}

          constructor

          constructor(
          eventManager: EventManager,
          ngZone: NgZone,
          document: any,
          sharedStylesHost: ɵSharedStylesHost
          );

            property ɵfac

            static ɵfac: i0.ɵɵFactoryDeclaration<ɵServerRendererFactory2, never>;

              property ɵprov

              static ɵprov: i0.ɵɵInjectableDeclaration<ɵServerRendererFactory2>;

                method begin

                begin: () => void;

                  method createRenderer

                  createRenderer: (element: any, type: RendererType2 | null) => Renderer2;

                    method end

                    end: () => void;

                      class PlatformState

                      class PlatformState {}
                      • Representation of the current platform state.

                      constructor

                      constructor(_doc: any);

                        property ɵfac

                        static ɵfac: i0.ɵɵFactoryDeclaration<PlatformState, never>;

                          property ɵprov

                          static ɵprov: i0.ɵɵInjectableDeclaration<PlatformState>;

                            method getDocument

                            getDocument: () => any;
                            • Returns the current DOM state.

                            method renderToString

                            renderToString: () => string;
                            • Renders the current state of the platform to string.

                            class ServerModule

                            class ServerModule {}
                            • The ng module for the server.

                            property ɵfac

                            static ɵfac: i0.ɵɵFactoryDeclaration<ServerModule, never>;

                              property ɵinj

                              static ɵinj: i0.ɵɵInjectorDeclaration<ServerModule>;

                                property ɵmod

                                static ɵmod: i0.ɵɵNgModuleDeclaration<ServerModule, never, [any, any], [any]>;

                                  class ServerTransferStateModule

                                  class ServerTransferStateModule {}
                                  • NgModule to install on the server side while using the TransferState to transfer state from server to client.

                                    Note: this module is not needed if the renderApplication function is used. The renderApplication makes all providers from this module available in the application.

                                    Deprecated

                                    no longer needed, you can inject the TransferState in an app without providing this module.

                                  property ɵfac

                                  static ɵfac: i0.ɵɵFactoryDeclaration<ServerTransferStateModule, never>;

                                    property ɵinj

                                    static ɵinj: i0.ɵɵInjectorDeclaration<ServerTransferStateModule>;

                                      property ɵmod

                                      static ɵmod: i0.ɵɵNgModuleDeclaration<
                                      ServerTransferStateModule,
                                      never,
                                      never,
                                      never
                                      >;

                                        Interfaces

                                        interface PlatformConfig

                                        interface PlatformConfig {}
                                        • Config object passed to initialize the platform.

                                        property baseUrl

                                        baseUrl?: string;
                                        • The base URL for resolving absolute URL for HTTP requests. It must be set if useAbsoluteUrl is true, and must consist of protocol, hostname, and optional port. This option has no effect if useAbsoluteUrl is not enabled.

                                        property document

                                        document?: string;
                                        • The initial DOM to use to bootstrap the server application. create a new DOM using Domino

                                        property url

                                        url?: string;
                                        • The URL for the current application state. This is used for initializing the platform's location. protocol, hostname, and port will be overridden if baseUrl is set. none

                                        property useAbsoluteUrl

                                        useAbsoluteUrl?: boolean;
                                        • Whether to append the absolute URL to any relative HTTP requests. If set to true, this logic executes prior to any HTTP interceptors that may run later on in the request. baseUrl must be supplied if this flag is enabled. false

                                        Package Files (1)

                                        Dependencies (3)

                                        Dev Dependencies (0)

                                        No dev dependencies.

                                        Peer Dependencies (6)

                                        Badge

                                        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@angular/platform-server.

                                        • Markdown
                                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@angular/platform-server)
                                        • HTML
                                          <a href="https://www.jsdocs.io/package/@angular/platform-server"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>