@angular/router

CanLoad

interface

Deprecated

Interface that a class can implement to be a guard deciding if children can be loaded. If all guards return true, navigation continues. If any guard returns false, navigation is cancelled. If any guard returns a UrlTree, current navigation is cancelled and a new navigation starts to the UrlTree returned from the guard.

  
    interface CanLoad {  canLoad(route: Route, segments: UrlSegment[]): MaybeAsync<GuardResult>;}}

Interface that a class can implement to be a guard deciding if children can be loaded. If all guards return true, navigation continues. If any guard returns false, navigation is cancelled. If any guard returns a UrlTree, current navigation is cancelled and a new navigation starts to the UrlTree returned from the guard.

The following example implements a CanLoad function that decides whether the current user has permission to load requested child routes.

          class UserToken {}class Permissions {  canLoadChildren(user: UserToken, id: string, segments: UrlSegment[]): boolean {    return true;  }}@Injectable()class CanLoadTeamSection implements CanLoad {  constructor(private permissions: Permissions, private currentUser: UserToken) {}  canLoad(route: Route, segments: UrlSegment[]): Observable<boolean>|Promise<boolean>|boolean {    return this.permissions.canLoadChildren(this.currentUser, route, segments);  }}

Here, the defined guard function is provided as part of the Route object in the router configuration:

          @NgModule({  imports: [    RouterModule.forRoot([      {        path: 'team/:id',        component: TeamComponent,        loadChildren: () => import('./team').then(mod => mod.TeamModule),        canLoad: [CanLoadTeamSection]      }    ])  ],  providers: [CanLoadTeamSection, UserToken, Permissions]})class AppModule {}

canLoad

MaybeAsync<GuardResult>

@paramrouteRoute

@paramsegmentsUrlSegment[]

@returnsMaybeAsync<GuardResult>