docs: add detail to router event doc

angular · Aug 14, 2019 · e135ad0 · e135ad0
1 parent cda205d
commit e135ad0
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/packages/router/src/events.ts b/packages/router/src/events.ts
@@ -122,7 +122,13 @@ 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 a promise that resolves to `false`,
+ * or an observable that emits `false`).
+ * The current navigation is also canceled when a route guard
+ * initiates redirect.
  *
  * @publicApi
  */