W3cubDocs

/Angular

RouterTestingModule

ngmodule

Sets up the router to be used for testing.

See more...

class RouterTestingModule {
  static withRoutes(routes: Route[], 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: Route[], config?: ExtraOptions): ModuleWithProviders<RouterTestingModule>

Parameters
routes Route[]
config ExtraOptions

Optional. Default is undefined.

Returns

ModuleWithProviders<RouterTestingModule>

Providers

Provider
ROUTER_PROVIDERS
EXTRA_ROUTER_TESTING_PROVIDERS
{ provide: Location, useClass: SpyLocation }
{ provide: LocationStrategy, useClass: MockLocationStrategy }
{
    provide: Router,
    useFactory: setupTestingRouter,
    deps: [
        UrlSerializer, ChildrenOutletContexts, Location, Compiler, Injector, ROUTES,
        ROUTER_CONFIGURATION, [UrlHandlingStrategy, new Optional()],
        [RouteReuseStrategy, new Optional()]
    ]
}
{ provide: PreloadingStrategy, useExisting: NoPreloading }
provideRoutes([])

Usage notes

Example

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

© 2010–2021 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://angular.io/api/router/testing/RouterTestingModule