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
This commit is contained in:
George Kalpakas
2019-09-17 01:14:04 +03:00
committed by atscott
parent e41cbfb585
commit a23ee2b0a1
3 changed files with 22 additions and 19 deletions

View File

@ -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>;