docs: add detail to router event doc (#32140)

PR Close #32140
2019-08-14 11:04:26 -07:00
parent ef2047555a
commit e3f42818e9
2 changed files with 6 additions and 2 deletions
--- a/packages/router/src/events.ts
+++ b/packages/router/src/events.ts
@ -122,7 +122,10 @@ export class NavigationEnd extends RouterEvent {
 }

 /**
- * An event triggered when a navigation is canceled.
+ * An event triggered when a navigation is canceled, directly or indirectly.
+ *
+ * This can happen when a [route guard](guide/router#milestone-5-route-guards)
+ * returns `false` or initiates a redirect by returning a `UrlTree`.
 *
 * @publicApi
 */