@angular/router 7.2.7 → 7.2.11

package/fesm2015/router.js

@@ -1,5 +1,5 @@
 /**
- * @license Angular v7.2.7
+ * @license Angular v7.2.11
  * (c) 2010-2019 Google LLC. https://angular.io/
  * License: MIT
  */
@@ -4922,9 +4922,10 @@ function defaultRouterHook(snapshot, runExtras) {
 /**
  * \@description
  *
- * Provides the navigation and url manipulation capabilities.
+ * An NgModule that provides navigation and URL manipulation capabilities.
  *
- * See `Routes` for more details and examples.
+ * @see `Route`.
+ * @see [Routing and Navigation Guide](guide/router).
  *
  * \@ngModule RouterModule
  *
@@ -4953,11 +4954,12 @@ class Router {
         this.currentNavigation = null;
         this.navigationId = 0;
         this.isNgZoneEnabled = false;
+        /**
+         * An event stream for routing events in this NgModule.
+         */
         this.events = new Subject();
         /**
-         * Error handler that is invoked when a navigation errors.
-         *
-         * See `ErrorHandler` for more information.
+         * A handler for navigation errors in this NgModule.
          */
         this.errorHandler = defaultErrorHandler;
         /**
@@ -4967,13 +4969,16 @@ class Router {
          */
         this.malformedUriErrorHandler = defaultMalformedUriErrorHandler;
         /**
-         * Indicates if at least one navigation happened.
+         * True if at least one navigation event has occurred,
+         * false otherwise.
          */
         this.navigated = false;
         this.lastSuccessfulId = -1;
         /**
-         * Used by RouterModule. This allows us to
-         * pause the navigation either before preactivation or after it.
+         * Hooks that enable you to pause navigation,
+         * either before or after the preactivation phase.
+         * Used by `RouterModule`.
+         *
          * \@internal
          */
         this.hooks = {
@@ -4984,21 +4989,24 @@ class Router {
          * Extracts and merges URLs. Used for AngularJS to Angular migrations.
          */
         this.urlHandlingStrategy = new DefaultUrlHandlingStrategy();
+        /**
+         * The strategy for re-using routes.
+         */
         this.routeReuseStrategy = new DefaultRouteReuseStrategy();
         /**
-         * Define what the router should do if it receives a navigation request to the current URL.
-         * By default, the router will ignore this navigation. However, this prevents features such
-         * as a "refresh" button. Use this option to configure the behavior when navigating to the
-         * current URL. Default is 'ignore'.
+         * How to handle a navigation request to the current URL. One of:
+         * - `'ignore'` :  The router ignores the request.
+         * - `'reload'` : The router reloads the URL. Use to implement a "refresh" feature.
          */
         this.onSameUrlNavigation = 'ignore';
         /**
-         * Defines how the router merges params, data and resolved data from parent to child
-         * routes. Available options are:
+         * How to merge parameters, data, and resolved data from parent to child
+         * routes. One of:
          *
-         * - `'emptyOnly'`, the default, only inherits parent params for path-less or component-less
-         *   routes.
-         * - `'always'`, enables unconditional inheritance of parent params.
+         * - `'emptyOnly'` : Inherit parent parameters, data, and resolved data
+         * for path-less or component-less routes.
+         * - `'always'` : Inherit parent parameters, data, and resolved data
+         * for all child routes.
          */
         this.paramsInheritanceStrategy = 'emptyOnly';
         /**
@@ -5369,7 +5377,7 @@ class Router {
         }
     }
     /**
-     * The current url
+     * The current URL.
      * @return {?}
      */
     get url() { return this.serializeUrl(this.currentUrlTree); }
@@ -5389,8 +5397,6 @@ class Router {
      *
      * \@usageNotes
      *
-     * ### Example
-     *
      * ```
      * router.resetConfig([
      *  { path: 'team/:id', component: TeamCmp, children: [
@@ -5399,7 +5405,8 @@ class Router {
      *  ]}
      * ]);
      * ```
-     * @param {?} config
+     * @param {?} config The route array for the new configuration.
+     *
      * @return {?}
      */
     resetConfig(config) {
@@ -5414,7 +5421,7 @@ class Router {
      */
     ngOnDestroy() { this.dispose(); }
     /**
-     * Disposes of the router
+     * Disposes of the router.
      * @return {?}
      */
     dispose() {
@@ -5424,15 +5431,13 @@ class Router {
         }
     }
     /**
-     * Applies an array of commands to the current url tree and creates a new url tree.
+     * Applies an array of commands to the current URL tree and creates a new URL tree.
      *
      * When given an activate route, applies the given commands starting from the route.
      * When not given a route, applies the given command starting from the root.
      *
      * \@usageNotes
      *
-     * ### Example
-     *
      * ```
      * // create /team/33/user/11
      * router.createUrlTree(['/team', 33, 'user', 11]);
@@ -5465,9 +5470,10 @@ class Router {
      * // navigate to /team/44/user/22
      * router.createUrlTree(['../../team/44/user/22'], {relativeTo: route});
      * ```
-     * @param {?} commands
+     * @param {?} commands An array of commands to apply.
      * @param {?=} navigationExtras
-     * @return {?}
+     * @return {?} The new URL tree.
+     *
      */
     createUrlTree(commands, navigationExtras = {}) {
         const { relativeTo, queryParams, fragment, preserveQueryParams, queryParamsHandling, preserveFragment } = navigationExtras;
@@ -5501,12 +5507,7 @@ class Router {
         return createUrlTree(a, this.currentUrlTree, commands, (/** @type {?} */ (q)), (/** @type {?} */ (f)));
     }
     /**
-     * Navigate based on the provided url. This navigation is always absolute.
-     *
-     * Returns a promise that:
-     * - resolves to 'true' when navigation succeeds,
-     * - resolves to 'false' when navigation fails,
-     * - is rejected when an error happens.
+     * Navigate based on the provided URL, which must be absolute.
      *
      * \@usageNotes
      *
@@ -5519,13 +5520,14 @@ class Router {
      * router.navigateByUrl("/team/33/user/11", { skipLocationChange: true });
      * ```
      *
-     * Since `navigateByUrl()` takes an absolute URL as the first parameter,
-     * it will not apply any delta to the current URL and ignores any properties
-     * in the second parameter (the `NavigationExtras`) that would change the
+     * @param {?} url An absolute URL. The function does not apply any delta to the current URL.
+     * @param {?=} extras An object containing properties that modify the navigation strategy.
+     * The function ignores any properties in the `NavigationExtras` that would change the
      * provided URL.
-     * @param {?} url
-     * @param {?=} extras
-     * @return {?}
+     *
+     * @return {?} A Promise that resolves to 'true' when navigation succeeds,
+     * to 'false' when navigation fails, or is rejected on error.
+     *
      */
     navigateByUrl(url, extras = { skipLocationChange: false }) {
         if (isDevMode() && this.isNgZoneEnabled && !NgZone.isInAngularZone()) {
@@ -7277,7 +7279,7 @@ function provideRouterInitializer() {
  * \@publicApi
  * @type {?}
  */
-const VERSION = new Version('7.2.7');
+const VERSION = new Version('7.2.11');
 
 /**
  * @fileoverview added by tsickle