honeymoose/angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add publicapi flag (#29012)

Browse Source 
PR Close #29012
This commit is contained in:
Judy Bogart 2019-03-05 11:32:29 -08:00 committed by Kara Erickson
parent 22c71b69ce
commit b14df413eb
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
packages/router/src/config.ts
View File

@ -22,6 +22,7 @@ import {UrlSegment, UrlSegmentGroup} from './url_tree';
* *
* @see `Route` * @see `Route`
* @see `Router` * @see `Router`
* @publicApi
*/ */
export type Routes = Route[]; export type Routes = Route[];
@ -32,7 +33,7 @@ export type Routes = Route[];
* * `posParams` is a map of positional parameters. * * `posParams` is a map of positional parameters.
* *
* @see `UrlMatcher()` * @see `UrlMatcher()`
* * @publicApi
*/ */
export type UrlMatchResult = { export type UrlMatchResult = {
consumed: UrlSegment[]; posParams?: {[name: string]: UrlSegment}; consumed: UrlSegment[]; posParams?: {[name: string]: UrlSegment};
@ -60,6 +61,7 @@ export type UrlMatchResult = {
* export const routes = [{ matcher: htmlFiles, component: AnyComponent }]; * export const routes = [{ matcher: htmlFiles, component: AnyComponent }];
* ``` * ```
* *
* @publicApi
*/ */
export type UrlMatcher = (segments: UrlSegment[], group: UrlSegmentGroup, route: Route) => export type UrlMatcher = (segments: UrlSegment[], group: UrlSegmentGroup, route: Route) =>
UrlMatchResult; UrlMatchResult;
@ -70,6 +72,7 @@ export type UrlMatcher = (segments: UrlSegment[], group: UrlSegmentGroup, route:
* *
* @see `Route#data` * @see `Route#data`
* *
* @publicApi
*/ */
export type Data = { export type Data = {
[name: string]: any [name: string]: any
@ -81,6 +84,7 @@ export type Data = {
* *
* @see `Route#resolve`. * @see `Route#resolve`.
* *
* @publicApi
*/ */
export type ResolveData = { export type ResolveData = {
[name: string]: any [name: string]: any
@ -91,7 +95,7 @@ export type ResolveData = {
* A function that is called to resolve a collection of lazy-loaded routes. * A function that is called to resolve a collection of lazy-loaded routes.
* *
* @see `Route#loadChildren`. * @see `Route#loadChildren`.
* * @publicApi
*/ */
export type LoadChildrenCallback = () => export type LoadChildrenCallback = () =>
Type<any>| NgModuleFactory<any>| Promise<Type<any>>| Observable<Type<any>>; Type<any>| NgModuleFactory<any>| Promise<Type<any>>| Observable<Type<any>>;
@ -102,7 +106,7 @@ export type LoadChildrenCallback = () =>
* or a function that returns such a set. * or a function that returns such a set.
* *
* @see `Route#loadChildren`. * @see `Route#loadChildren`.
* * @publicApi
*/ */
export type LoadChildren = string | LoadChildrenCallback; export type LoadChildren = string | LoadChildrenCallback;
@ -114,7 +118,7 @@ export type LoadChildren = string | LoadChildrenCallback;
* - `preserve` : Preserve current parameters. * - `preserve` : Preserve current parameters.
* *
* @see `RouterLink#queryParamsHandling`. * @see `RouterLink#queryParamsHandling`.
* * @publicApi
*/ */
export type QueryParamsHandling = 'merge' | 'preserve' | ''; export type QueryParamsHandling = 'merge' | 'preserve' | '';
@ -123,6 +127,7 @@ export type QueryParamsHandling = 'merge' | 'preserve' | '';
* A policy for when to run guards and resolvers on a route. * A policy for when to run guards and resolvers on a route.
* *
* @see `Route#runGuardsAndResolvers` * @see `Route#runGuardsAndResolvers`
* @publicApi
*/ */
export type RunGuardsAndResolvers = 'pathParamsChange' | 'pathParamsOrQueryParamsChange' | export type RunGuardsAndResolvers = 'pathParamsChange' | 'pathParamsOrQueryParamsChange' |
'paramsChange' | 'paramsOrQueryParamsChange' | 'always' | 'paramsChange' | 'paramsOrQueryParamsChange' | 'always' |
@ -344,6 +349,7 @@ export type RunGuardsAndResolvers = 'pathParamsChange' | 'pathParamsOrQueryParam
* }] * }]
* ``` * ```
* *
* @publicApi
*/ */
export interface Route { export interface Route {
/** /**