From b934898e452b3cb43ff711e04620ffb7d79f9cd4 Mon Sep 17 00:00:00 2001
From: Ferdinand Malcher <ferdinand@malcher.media>
Date: Tue, 23 Jul 2019 23:03:46 +0200
Subject: [PATCH] docs(router): Update description and example for Resolve
 interface (#31810)

PR Close #31810
---
 packages/router/src/interfaces.ts | 43 ++++++++++++++++---------------
 1 file changed, 22 insertions(+), 21 deletions(-)

diff --git a/packages/router/src/interfaces.ts b/packages/router/src/interfaces.ts
index 522f64953f..f991838abd 100644
--- a/packages/router/src/interfaces.ts
+++ b/packages/router/src/interfaces.ts
@@ -265,23 +265,20 @@ export type CanDeactivateFn<T> =
  * @description
  *
  * Interface that classes can implement to be a data provider.
+ * A data provider class can be used with the router to resolve data during navigation.
+ * The interface defines a `resolve()` method that will be invoked when the navigation starts.
+ * The router will then wait for the data to be resolved before the route is finally activated.
  *
  * ```
- * class Backend {
- *   fetchTeam(id: string) {
- *     return 'someTeam';
- *   }
- * }
- *
- * @Injectable()
- * class TeamResolver implements Resolve<Team> {
- *   constructor(private backend: Backend) {}
+ * @Injectable({ providedIn: 'root' })
+ * export class HeroResolver implements Resolve<Hero> {
+ *   constructor(private service: HeroService) {}
  *
  *   resolve(
  *     route: ActivatedRouteSnapshot,
  *     state: RouterStateSnapshot
  *   ): Observable<any>|Promise<any>|any {
- *     return this.backend.fetchTeam(route.params.id);
+ *     return this.service.getHero(route.paramMap.get('id'));
  *   }
  * }
  *
@@ -289,42 +286,46 @@ export type CanDeactivateFn<T> =
  *   imports: [
  *     RouterModule.forRoot([
  *       {
- *         path: 'team/:id',
- *         component: TeamComponent,
+ *         path: 'detail/:id',
+ *         component: HeroDetailComponent,
  *         resolve: {
- *           team: TeamResolver
+ *           hero: HeroResolver
  *         }
  *       }
  *     ])
  *   ],
- *   providers: [TeamResolver]
+ *   exports: [RouterModule]
  * })
- * class AppModule {}
+ * export class AppRoutingModule {}
  * ```
  *
  * You can alternatively provide a function with the `resolve` signature:
  *
  * ```
+ * export const myHero: Hero = {
+ *   // ...
+ * }
+ *
  * @NgModule({
  *   imports: [
  *     RouterModule.forRoot([
  *       {
- *         path: 'team/:id',
- *         component: TeamComponent,
+ *         path: 'detail/:id',
+ *         component: HeroComponent,
  *         resolve: {
- *           team: 'teamResolver'
+ *           hero: 'heroResolver'
  *         }
  *       }
  *     ])
  *   ],
  *   providers: [
  *     {
- *       provide: 'teamResolver',
- *       useValue: (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => 'team'
+ *       provide: 'heroResolver',
+ *       useValue: (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => myHero
  *     }
  *   ]
  * })
- * class AppModule {}
+ * export class AppModule {}
  * ```
  *
  * @publicApi