more_horiz
@angular/corecode
PlatformRef
Class
stable
The Angular platform is the entry point for Angular on a web page.
Each page has exactly one platform. Services (such as reflection) which are common
to every Angular application running on the page are bound in its scope.
A page's platform is initialized implicitly when a platform is created using a platform
factory such as PlatformBrowser, or explicitly by calling the createPlatform() function.
On this page
API
class PlatformRef { constructor(_injector: Injector); bootstrapModuleFactory<M>(moduleFactory: NgModuleFactory<M>, options?: (BootstrapOptions & { applicationProviders?: (Provider | EnvironmentProviders)[] | undefined; }) | undefined): Promise<NgModuleRef<M>>; bootstrapModule<M>(moduleType: Type<M>, compilerOptions?: (CompilerOptions & BootstrapOptions & { applicationProviders?: (Provider | EnvironmentProviders)[] | undefined; }) | (CompilerOptions & BootstrapOptions & { applicationProviders?: (Provider | EnvironmentProviders)[] | undefined; })[]): Promise<NgModuleRef<M>>; onDestroy(callback: () => void): void; readonly injector: Injector; destroy(): void; readonly destroyed: boolean;}
bootstrapModuleFactory
Promise<NgModuleRef<M>>Creates an instance of an @NgModule for the given platform.
@paramoptions
(BootstrapOptions & { applicationProviders?: (Provider | EnvironmentProviders)[] | undefined; }) | undefined@returns
Promise<NgModuleRef<M>>bootstrapModule
Promise<NgModuleRef<M>>Creates an instance of an @NgModule for a given platform.
@paramcompilerOptions
(CompilerOptions & BootstrapOptions & { applicationProviders?: (Provider | EnvironmentProviders)[] | undefined; }) | (CompilerOptions & BootstrapOptions & { applicationProviders?: (Provider | EnvironmentProviders)[] | undefined; })[]@returns
Promise<NgModuleRef<M>>Usage notes
Simple Example
@NgModule({
imports: [BrowserModule]
})
class MyModule {}
let moduleRef = platformBrowser().bootstrapModule(MyModule);onDestroy
voidRegisters a listener to be called when the platform is destroyed.
@paramcallback
() => void@returns
voidinjector
InjectorRetrieves the platform Injector, which is the parent injector for
every Angular application on the page and provides singleton providers.
destroy
voidDestroys the current Angular platform and all Angular applications on the page. Destroys all modules and listeners registered with the platform.
@returns
voidJump to details