@angular/router

CanActivateChildFn

Type Alias

The signature of a function used as a canActivateChild guard on a Route.

type CanActivateChildFn = (
  childRoute: ActivatedRouteSnapshot,
  state: RouterStateSnapshot,
) => MaybeAsync<GuardResult>

The signature of a function used as a canActivateChild guard on a Route.

If all guards return true, navigation continues. If any guard returns false, navigation is cancelled. If any guard returns a UrlTree, the current navigation is cancelled and a new navigation begins to the UrlTree returned from the guard.

The following example implements a canActivate function that checks whether the current user has permission to activate the requested route.

{@example router/route_functional_guards.ts region="CanActivateChildFn"}