Resolve

Stable Interface

What it does

Indicates that class can implement to be a data provider.

How to use

class Backend {
  fetchTeam(id: string) {
    return 'someTeam';
  }
}
 
@Injectable()
class TeamResolver implements Resolve<Team> {
  constructor(private backend: Backend) {}
 
  resolve(
    route: ActivatedRouteSnapshot,
    state: RouterStateSnapshot
  ): Observable<any>|Promise<any>|any {
    return this.backend.fetchTeam(route.params.id);
  }
}
 
@NgModule({
  imports: [
    RouterModule.forRoot([
      {
        path: 'team/:id',
        component: TeamCmp,
        resolve: {
          team: TeamResolver
        }
      }
    ])
  ],
  providers: [TeamResolver]
})
class AppModule {}

You can also provide a function with the same signature instead of the class.

@NgModule({
  imports: [
    RouterModule.forRoot([
      {
        path: 'team/:id',
        component: TeamCmp,
        resolve: {
          team: 'teamResolver'
        }
      }
    ])
  ],
  providers: [
    {
      provide: 'teamResolver',
      useValue: (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => 'team'
    }
  ]
})
class AppModule {}

Interface Overview

interface Resolve {
  resolve(route: ActivatedRouteSnapshot, state: RouterStateSnapshot) : Observable<any>|Promise<any>|any
}

Interface Description

Interface Details

resolve(route: ActivatedRouteSnapshot, state: RouterStateSnapshot) : Observable<any>|Promise<any>|any

exported from @angular/router/index, defined in @angular/router/src/interfaces.ts

Links:

https://angular.io/docs/ts/latest/api/router/index/Resolve-interface.html

doc_Angular

2025-01-10 15:47:30

Comments