docs(router): make `InitialNavigation` part of the public API (#32707)

`InitialNavigation` is used in `ExtraOptions`, which is already part of
the public API. Thus, `InitialNavigation` should be too. Not publicly
exporting it from `router/index.ts` seems an omission, since the type is
already annotated with the `@publicApi` JSDoc tag.

By publicly exporting `InitialNavigation`, it will also correctly appear
in the API docs on angular.io.

PR Close #32707

packages/router/src/index.ts

@@ -16,7 +16,7 @@ export {CanActivate, CanActivateChild, CanDeactivate, CanLoad, Resolve} from './
 export {DetachedRouteHandle, RouteReuseStrategy} from './route_reuse_strategy';
 export {Navigation, NavigationExtras, Router} from './router';
 export {ROUTES} from './router_config_loader';
-export {ExtraOptions, ROUTER_CONFIGURATION, ROUTER_INITIALIZER, RouterModule, provideRoutes} from './router_module';
+export {ExtraOptions, InitialNavigation, ROUTER_CONFIGURATION, ROUTER_INITIALIZER, RouterModule, provideRoutes} from './router_module';
 export {ChildrenOutletContexts, OutletContext} from './router_outlet_context';
 export {NoPreloading, PreloadAllModules, PreloadingStrategy, RouterPreloader} from './router_preloader';
 export {ActivatedRoute, ActivatedRouteSnapshot, RouterState, RouterStateSnapshot} from './router_state';

packages/router/src/router_module.ts

@@ -327,24 +327,24 @@ export interface ExtraOptions {
    *
    * ```typescript
    * class AppModule {
-    *   constructor(router: Router, viewportScroller: ViewportScroller) {
+   *   constructor(router: Router, viewportScroller: ViewportScroller) {
-    *     router.events.pipe(
+   *     router.events.pipe(
-    *       filter((e: Event): e is Scroll => e instanceof Scroll)
+   *       filter((e: Event): e is Scroll => e instanceof Scroll)
-    *     ).subscribe(e => {
+   *     ).subscribe(e => {
-    *       if (e.position) {
+   *       if (e.position) {
-    *         // backward navigation
+   *         // backward navigation
-    *         viewportScroller.scrollToPosition(e.position);
+   *         viewportScroller.scrollToPosition(e.position);
-    *       } else if (e.anchor) {
+   *       } else if (e.anchor) {
-    *         // anchor navigation
+   *         // anchor navigation
-    *         viewportScroller.scrollToAnchor(e.anchor);
+   *         viewportScroller.scrollToAnchor(e.anchor);
-    *       } else {
+   *       } else {
-    *         // forward navigation
+   *         // forward navigation
-    *         viewportScroller.scrollToPosition([0, 0]);
+   *         viewportScroller.scrollToPosition([0, 0]);
-    *       }
+   *       }
-    *     });
+   *     });
-    *   }
+   *   }
-    * }
+   * }
-    * ```
+   * ```
    */
   scrollPositionRestoration?: 'disabled'|'enabled'|'top';
 

tools/public_api_guard/router/router.d.ts

@@ -148,6 +148,9 @@ export declare class GuardsCheckStart extends RouterEvent {
     toString(): string;
 }
 
+/** @deprecated */
+export declare type InitialNavigation = true | false | 'enabled' | 'disabled' | 'legacy_enabled' | 'legacy_disabled';
+
 export declare type LoadChildren = LoadChildrenCallback | DeprecatedLoadChildren;
 
 export declare type LoadChildrenCallback = () => Type<any> | NgModuleFactory<any> | Observable<Type<any>> | Promise<NgModuleFactory<any> | Type<any> | any>;