This is the archived documentation for Angular v6. Please visit angular.io to see documentation for the current version of Angular.
API > @angular/upgrade > @angular/upgrade/static

downgradeModule

A helper function for creating an AngularJS module that can bootstrap an Angular module "on-demand" (possibly lazily) when a downgraded component needs to be instantiated.

See more...

downgradeModule<T>(moduleFactoryOrBootstrapFn: NgModuleFactory<T> | ((extraProviders: StaticProvider[]) => Promise<NgModuleRef<T>>)): string
      
      downgradeModule<T>(moduleFactoryOrBootstrapFn: NgModuleFactory<T> | ((extraProviders: StaticProvider[]) => Promise<NgModuleRef<T>>)): string

Parameters

moduleFactoryOrBootstrapFn

Type: NgModuleFactory | ((extraProviders: StaticProvider[]) => Promise>).

Returns

string

Description

Part of the upgrade/static library for hybrid upgrade apps that support AoT compilation.

It allows loading/bootstrapping the Angular part of a hybrid application lazily and not having to pay the cost up-front. For example, you can have an AngularJS application that uses Angular for specific routes and only instantiate the Angular modules if/when the user visits one of these routes.

The Angular module will be bootstrapped once (when requested for the first time) and the same reference will be used from that point onwards.

downgradeModule() requires either an NgModuleFactory or a function:

downgradeModule() returns the name of the created AngularJS wrapper module. You can use it to declare a dependency in your main AngularJS module.

// Alternatively, we could import and use an `NgModuleFactory` instead: // import {MyLazyAngularModuleNgFactory} from './my-lazy-angular-module.ngfactory'; import {platformBrowserDynamic} from '@angular/platform-browser-dynamic'; import {downgradeModule} from '@angular/upgrade/static'; // The function that will bootstrap the Angular module (when/if necessary). // (This would be omitted if we provided an `NgModuleFactory` directly.) const ng2BootstrapFn = (extraProviders: StaticProvider[]) => platformBrowserDynamic(extraProviders).bootstrapModule(MyLazyAngularModule); // This AngularJS module represents the AngularJS pieces of the application. const myMainAngularJsModule = angular.module('myMainAngularJsModule', [ // We declare a dependency on the "downgraded" Angular module. downgradeModule(ng2BootstrapFn) // or // downgradeModule(MyLazyAngularModuleFactory) ]); 
      
      
  1. // Alternatively, we could import and use an `NgModuleFactory` instead:
  2. // import {MyLazyAngularModuleNgFactory} from './my-lazy-angular-module.ngfactory';
  3. import {platformBrowserDynamic} from '@angular/platform-browser-dynamic';
  4. import {downgradeModule} from '@angular/upgrade/static';
  5.  
  6.  
  7. // The function that will bootstrap the Angular module (when/if necessary).
  8. // (This would be omitted if we provided an `NgModuleFactory` directly.)
  9. const ng2BootstrapFn = (extraProviders: StaticProvider[]) =>
  10.     platformBrowserDynamic(extraProviders).bootstrapModule(MyLazyAngularModule);
  11.  
  12.  
  13. // This AngularJS module represents the AngularJS pieces of the application.
  14. const myMainAngularJsModule = angular.module('myMainAngularJsModule', [
  15.   // We declare a dependency on the "downgraded" Angular module.
  16.   downgradeModule(ng2BootstrapFn)
  17.   // or
  18.   // downgradeModule(MyLazyAngularModuleFactory)
  19. ]);

For more details on how to use downgradeModule() see Upgrading for Performance.

Usage notes

Apart from UpgradeModule, you can use the rest of the upgrade/static helpers as usual to build a hybrid application. Note that the Angular pieces (e.g. downgraded services) will not be available until the downgraded module has been bootstrapped, i.e. by instantiating a downgraded component.

You cannot use downgradeModule() and UpgradeModule in the same hybrid application.
Use one or the other.

Differences with UpgradeModule

Besides their different API, there are two important internal differences between downgradeModule() and UpgradeModule that affect the behavior of hybrid applications:

  1. Unlike UpgradeModule, downgradeModule() does not bootstrap the main AngularJS module inside the Angular zone.
  2. Unlike UpgradeModule, downgradeModule() does not automatically run a $digest() when changes are detected in the Angular part of the application.

What this means is that applications using UpgradeModule will run change detection more frequently in order to ensure that both frameworks are properly notified about possible changes. This will inevitably result in more change detection runs than necessary.

downgradeModule(), on the other side, does not try to tie the two change detection systems as tightly, restricting the explicit change detection runs only to cases where it knows it is necessary (e.g. when the inputs of a downgraded component change). This improves performance, especially in change-detection-heavy applications, but leaves it up to the developer to manually notify each framework as needed.

For a more detailed discussion of the differences and their implications, see Upgrading for Performance.

You can manually trigger a change detection run in AngularJS using scope.$apply(...) or $rootScope.$digest().

You can manually trigger a change detection run in Angular using ngZone.run(...).