Skip to content

Commit

Permalink
docs: add publicapi flag
Browse files Browse the repository at this point in the history
  • Loading branch information
jbogarthyde committed Mar 6, 2019
1 parent 2af38e9 commit 2560999
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions packages/router/src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import {UrlSegment, UrlSegmentGroup} from './url_tree';
*
* @see `Route`
* @see `Router`
* @publicApi
*/
export type Routes = Route[];

Expand All @@ -32,7 +33,7 @@ export type Routes = Route[];
* * `posParams` is a map of positional parameters.
*
* @see `UrlMatcher()`
*
* @publicApi
*/
export type UrlMatchResult = {
consumed: UrlSegment[]; posParams?: {[name: string]: UrlSegment};
Expand Down Expand Up @@ -60,6 +61,7 @@ export type UrlMatchResult = {
* export const routes = [{ matcher: htmlFiles, component: AnyComponent }];
* ```
*
* @publicApi
*/
export type UrlMatcher = (segments: UrlSegment[], group: UrlSegmentGroup, route: Route) =>
UrlMatchResult;
Expand All @@ -70,6 +72,7 @@ export type UrlMatcher = (segments: UrlSegment[], group: UrlSegmentGroup, route:
*
* @see `Route#data`
*
* @publicApi
*/
export type Data = {
[name: string]: any
Expand All @@ -81,6 +84,7 @@ export type Data = {
*
* @see `Route#resolve`.
*
* @publicApi
*/
export type ResolveData = {
[name: string]: any
Expand All @@ -91,7 +95,7 @@ export type ResolveData = {
* A function that is called to resolve a collection of lazy-loaded routes.
*
* @see `Route#loadChildren`.
*
* @publicApi
*/
export type LoadChildrenCallback = () =>
Type<any>| NgModuleFactory<any>| Promise<Type<any>>| Observable<Type<any>>;
Expand All @@ -102,7 +106,7 @@ export type LoadChildrenCallback = () =>
* or a function that returns such a set.
*
* @see `Route#loadChildren`.
*
* @publicApi
*/
export type LoadChildren = string | LoadChildrenCallback;

Expand All @@ -114,7 +118,7 @@ export type LoadChildren = string | LoadChildrenCallback;
* - `preserve` : Preserve current parameters.
*
* @see `RouterLink#queryParamsHandling`.
*
* @publicApi
*/
export type QueryParamsHandling = 'merge' | 'preserve' | '';

Expand All @@ -123,6 +127,7 @@ export type QueryParamsHandling = 'merge' | 'preserve' | '';
* A policy for when to run guards and resolvers on a route.
*
* @see `Route#runGuardsAndResolvers`
* @publicApi
*/
export type RunGuardsAndResolvers = 'pathParamsChange' | 'pathParamsOrQueryParamsChange' |
'paramsChange' | 'paramsOrQueryParamsChange' | 'always' |
Expand Down Expand Up @@ -344,6 +349,7 @@ export type RunGuardsAndResolvers = 'pathParamsChange' | 'pathParamsOrQueryParam
* }]
* ```
*
* @publicApi
*/
export interface Route {
/**
Expand Down

0 comments on commit 2560999

Please sign in to comment.