fix(router): Expose CanMatchFn as public API (#46394)

atscott · AndrewKushnir · commit f94c6f433dba · 2022-06-17T09:18:08.000-07:00
The `CanMatchFn` is already exposed in the type signature for `canMatch` on the `Route`. This function type should already be exposed as public API but was missed in the initial implementation because the older guards use the `any` type instead. PR Close #46394
diff --git a/goldens/public-api/router/index.md b/goldens/public-api/router/index.md
@@ -141,6 +141,9 @@ export interface CanMatch {
     canMatch(route: Route, segments: UrlSegment[]): Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree;
 }
 
+// @public
+export type CanMatchFn = (route: Route, segments: UrlSegment[]) => Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean;
+
 // @public
 export class ChildActivationEnd {
     constructor(
diff --git a/packages/router/src/index.ts b/packages/router/src/index.ts
@@ -12,7 +12,7 @@ export {RouterLink, RouterLinkWithHref} from './directives/router_link';
 export {RouterLinkActive} from './directives/router_link_active';
 export {RouterOutlet, RouterOutletContract} from './directives/router_outlet';
 export {ActivationEnd, ActivationStart, ChildActivationEnd, ChildActivationStart, Event, EventType, GuardsCheckEnd, GuardsCheckStart, NavigationCancel, NavigationEnd, NavigationError, NavigationStart, ResolveEnd, ResolveStart, RouteConfigLoadEnd, RouteConfigLoadStart, RouterEvent, RoutesRecognized, Scroll} from './events';
-export {CanActivate, CanActivateChild, CanDeactivate, CanLoad, CanMatch, Data, LoadChildren, LoadChildrenCallback, QueryParamsHandling, Resolve, ResolveData, Route, Routes, RunGuardsAndResolvers, UrlMatcher, UrlMatchResult} from './models';
+export {CanActivate, CanActivateChild, CanDeactivate, CanLoad, CanMatch, CanMatchFn, Data, LoadChildren, LoadChildrenCallback, QueryParamsHandling, Resolve, ResolveData, Route, Routes, RunGuardsAndResolvers, UrlMatcher, UrlMatchResult} from './models';
 export {DefaultTitleStrategy, TitleStrategy} from './page_title_strategy';
 export {BaseRouteReuseStrategy, DetachedRouteHandle, RouteReuseStrategy} from './route_reuse_strategy';
 export {Navigation, NavigationBehaviorOptions, NavigationExtras, Router, UrlCreationOptions} from './router';
diff --git a/packages/router/src/models.ts b/packages/router/src/models.ts
@@ -907,6 +907,13 @@ export interface CanMatch {
       Observable<boolean|UrlTree>|Promise<boolean|UrlTree>|boolean|UrlTree;
 }
 
+/**
+ * The signature of a function used as a `CanMatch` guard on a `Route`.
+ *
+ * @publicApi
+ * @see `CanMatch`
+ * @see `Route`
+ */
 export type CanMatchFn = (route: Route, segments: UrlSegment[]) =>
     Observable<boolean|UrlTree>|Promise<boolean|UrlTree>|boolean;
 
diff --git a/packages/router/test/apply_redirects.spec.ts b/packages/router/test/apply_redirects.spec.ts
@@ -262,7 +262,7 @@ describe('applyRedirects', () => {
         throw 'Should not be reached';
       }
     });
-  })
+  });
 
   describe('lazy loading', () => {
     it('should load config on demand', () => {

Original file line number	Diff line number	Diff line change
`@@ -141,6 +141,9 @@ export interface CanMatch {`
`141`	`141`	`canMatch(route: Route, segments: UrlSegment[]): Observable<boolean \| UrlTree> \| Promise<boolean \| UrlTree> \| boolean \| UrlTree;`
`142`	`142`	`}`
`143`	`143`
	`144`	`+// @public`
	`145`	`+export type CanMatchFn = (route: Route, segments: UrlSegment[]) => Observable<boolean \| UrlTree> \| Promise<boolean \| UrlTree> \| boolean;`
	`146`	`+`
`144`	`147`	`// @public`
`145`	`148`	`export class ChildActivationEnd {`
`146`	`149`	`constructor(`
Original file line number	Diff line number	Diff line change
`@@ -262,7 +262,7 @@ describe('applyRedirects', () => {`
`262`	`262`	`throw 'Should not be reached';`
`263`	`263`	`}`
`264`	`264`	`});`
`265`		`- })`
	`265`	`+ });`
`266`	`266`
`267`	`267`	`describe('lazy loading', () => {`
`268`	`268`	`it('should load config on demand', () => {`