/** * @license * Copyright Google Inc. All Rights Reserved. * * Use of this source code is governed by an MIT-style license that can be * found in the LICENSE file at https://angular.io/license */ import { HashLocationStrategy, Location, PathLocationStrategy, PlatformLocation } from '@angular/common'; import { ApplicationRef, Compiler, ComponentRef, Injector, ModuleWithProviders, NgModuleFactoryLoader, NgProbeToken, OpaqueToken, Provider } from '@angular/core'; import { Route, Routes } from './config'; import { RouteReuseStrategy } from './route_reuse_strategy'; import { ErrorHandler, Router } from './router'; import { RouterOutletMap } from './router_outlet_map'; import { RouterPreloader } from './router_preloader'; import { ActivatedRoute } from './router_state'; import { UrlHandlingStrategy } from './url_handling_strategy'; import { UrlSerializer } from './url_tree'; /** * @whatItDoes Is used in DI to configure the router. * @stable */ export declare const ROUTER_CONFIGURATION: OpaqueToken; /** * @docsNotRequired */ export declare const ROUTER_FORROOT_GUARD: OpaqueToken; export declare const ROUTER_PROVIDERS: Provider[]; export declare function routerNgProbeToken(): NgProbeToken; /** * @whatItDoes Adds router directives and providers. * * @howToUse * * RouterModule can be imported multiple times: once per lazily-loaded bundle. * Since the router deals with a global shared resource--location, we cannot have * more than one router service active. * * That is why there are two ways to create the module: `RouterModule.forRoot` and * `RouterModule.forChild`. * * * `forRoot` creates a module that contains all the directives, the given routes, and the router * service itself. * * `forChild` creates a module that contains all the directives and the given routes, but does not * include the router service. * * When registered at the root, the module should be used as follows * * ``` * @NgModule({ * imports: [RouterModule.forRoot(ROUTES)] * }) * class MyNgModule {} * ``` * * For submodules and lazy loaded submodules the module should be used as follows: * * ``` * @NgModule({ * imports: [RouterModule.forChild(ROUTES)] * }) * class MyNgModule {} * ``` * * @description * * Managing state transitions is one of the hardest parts of building applications. This is * especially true on the web, where you also need to ensure that the state is reflected in the URL. * In addition, we often want to split applications into multiple bundles and load them on demand. * Doing this transparently is not trivial. * * The Angular 2 router solves these problems. Using the router, you can declaratively specify * application states, manage state transitions while taking care of the URL, and load bundles on * demand. * * [Read this developer guide](https://angular.io/docs/ts/latest/guide/router.html) to get an * overview of how the router should be used. * * @stable */ export declare class RouterModule { constructor(guard: any); /** * Creates a module with all the router providers and directives. It also optionally sets up an * application listener to perform an initial navigation. * * Options: * * `enableTracing` makes the router log all its internal events to the console. * * `useHash` enables the location strategy that uses the URL fragment instead of the history * API. * * `initialNavigation` disables the initial navigation. * * `errorHandler` provides a custom error handler. */ static forRoot(routes: Routes, config?: ExtraOptions): ModuleWithProviders; /** * Creates a module with all the router directives and a provider registering routes. */ static forChild(routes: Routes): ModuleWithProviders; } export declare function provideLocationStrategy(platformLocationStrategy: PlatformLocation, baseHref: string, options?: ExtraOptions): HashLocationStrategy | PathLocationStrategy; export declare function provideForRootGuard(router: Router): any; /** * @whatItDoes Registers routes. * * @howToUse * * ``` * @NgModule({ * imports: [RouterModule.forChild(ROUTES)], * providers: [provideRoutes(EXTRA_ROUTES)] * }) * class MyNgModule {} * ``` * * @stable */ export declare function provideRoutes(routes: Routes): any; /** * @whatItDoes Represents options to configure the router. * * @stable */ export interface ExtraOptions { /** * Makes the router log all its internal events to the console. */ enableTracing?: boolean; /** * Enables the location strategy that uses the URL fragment instead of the history API. */ useHash?: boolean; /** * Disables the initial navigation. */ initialNavigation?: boolean; /** * A custom error handler. */ errorHandler?: ErrorHandler; /** * Configures a preloading strategy. See {@link PreloadAllModules}. */ preloadingStrategy?: any; } export declare function setupRouter(ref: ApplicationRef, urlSerializer: UrlSerializer, outletMap: RouterOutletMap, location: Location, injector: Injector, loader: NgModuleFactoryLoader, compiler: Compiler, config: Route[][], opts?: ExtraOptions, urlHandlingStrategy?: UrlHandlingStrategy, routeReuseStrategy?: RouteReuseStrategy): Router; export declare function rootRoute(router: Router): ActivatedRoute; export declare function initialRouterNavigation(router: Router, ref: ApplicationRef, preloader: RouterPreloader, opts: ExtraOptions): (bootstrappedComponentRef: ComponentRef) => void; /** * A token for the router initializer that will be called after the app is bootstrapped. * * @experimental */ export declare const ROUTER_INITIALIZER: OpaqueToken; export declare function provideRouterInitializer(): ({ provide: OpaqueToken; useFactory: (router: Router, ref: ApplicationRef, preloader: RouterPreloader, opts: ExtraOptions) => (bootstrappedComponentRef: ComponentRef) => void; deps: (OpaqueToken | typeof Router | typeof RouterPreloader | typeof ApplicationRef)[]; } | { provide: OpaqueToken; multi: boolean; useExisting: OpaqueToken; })[];