PlatformRef

interface

The Angular platform is the entry point for Angular on a web page. Each page has exactly one platform, and services (such as reflection) which are common to every Angular application running on the page are bound in its scope.

      
      interface PlatformRef {
  injector: Injector
  destroyed
  bootstrapModuleFactory<M>(moduleFactory: NgModuleFactory<M>, options?: BootstrapOptions): Promise<NgModuleRef<M>>
  bootstrapModule<M>(moduleType: Type<M>, compilerOptions: (CompilerOptions & BootstrapOptions) | (CompilerOptions & BootstrapOptions)[] = []): Promise<NgModuleRef<M>>
  onDestroy(callback: () => void): void
  destroy()
}

Description

A page's platform is initialized implicitly when a platform is created via a platform factory (e.g. platformBrowser), or explicitly by calling the createPlatform function.

Properties

Property	Description
`injector: Injector`	Read-only. Retrieve the platform `Injector`, which is the parent injector for every Angular application on the page and provides singleton providers.
`destroyed`	Read-only.

Methods

bootstrapModuleFactory()

Creates an instance of an @NgModule for the given platform for offline compilation.

      
      bootstrapModuleFactory<M>(moduleFactory: NgModuleFactory<M>, options?: BootstrapOptions): Promise<NgModuleRef<M>>

Parameters

`moduleFactory`	`NgModuleFactory`
`options`	`BootstrapOptions`	Optional. Default is `undefined`.

Returns

Promise<NgModuleRef<M>>

Usage Notes

Simple Example

      
      my_module.ts:
 
@NgModule({
  imports: [BrowserModule]
})
class MyModule {}
 
main.ts:
import {MyModuleNgFactory} from './my_module.ngfactory';
import {platformBrowser} from '@angular/platform-browser';
 
let moduleRef = platformBrowser().bootstrapModuleFactory(MyModuleNgFactory);

bootstrapModule()

Creates an instance of an @NgModule for a given platform using the given runtime compiler.

      
      bootstrapModule<M>(moduleType: Type<M>, compilerOptions: (CompilerOptions & BootstrapOptions) | (CompilerOptions & BootstrapOptions)[] = []): Promise<NgModuleRef<M>>

Parameters

`moduleType`	`Type`
`compilerOptions`	`(CompilerOptions & BootstrapOptions) \| (CompilerOptions & BootstrapOptions)[]`	Optional. Default is `[]`.

Returns

Promise<NgModuleRef<M>>

Usage Notes

Simple Example

      
      @NgModule({
  imports: [BrowserModule]
})
class MyModule {}

let moduleRef = platformBrowser().bootstrapModule(MyModule);

onDestroy()

      
      onDestroy(callback: () => void): void

Parameters

callback () => void

Returns

void

destroy()
Destroy the Angular platform and all Angular applications on the page.
destroy() `destroy()` Parameters There are no parameters.