Cookies concent notice

This site uses cookies from Google to deliver its services and to analyze traffic.
Learn more
Skip to main content
This site is no longer updated.Head to Angular.devHome
/

This is the archived documentation for Angular v17. Please visit angular.dev to see this page for the current version of Angular.

RouterTestingModule

Sets up the router to be used for testing.

See more...

Deprecated: Use provideRouter or RouterModule/RouterModule.forRoot instead. This module was previously used to provide a helpful collection of test fakes, most notably those for Location and LocationStrategy. These are generally not required anymore, as MockPlatformLocation is provided in TestBed by default. However, you can use them directly with provideLocationMocks.

      
      class RouterTestingModule {
  static withRoutes(routes: Routes, config?: ExtraOptions): ModuleWithProviders<RouterTestingModule>
}
    

Description

The modules sets up the router to be used for testing. It provides spy implementations of Location and LocationStrategy.

Further information is available in the Usage Notes...

Static methods

      
      static withRoutes(routes: Routes, config?: ExtraOptions): ModuleWithProviders<RouterTestingModule>
    
Parameters
routes Routes
config ExtraOptions

Optional. Default is undefined.

Returns

ModuleWithProviders<RouterTestingModule>

Providers

Provider
      
      ROUTER_PROVIDERS
    
      
      provideLocationMocks()
    
      
      withPreloading(NoPreloading).ɵproviders
    
      
      { provide: ROUTES, multi: true, useValue: [] }
    

Usage notes

Example

      
      beforeEach(() => {
  TestBed.configureTestingModule({
    imports: [
      RouterModule.forRoot(
        [{path: '', component: BlankCmp}, {path: 'simple', component: SimpleCmp}]
      )
    ]
  });
});