diff --git a/packages/router/src/router.ts b/packages/router/src/router.ts index f67a6c9a14..8c7a01f100 100644 --- a/packages/router/src/router.ts +++ b/packages/router/src/router.ts @@ -1027,7 +1027,10 @@ export class Router { return this.serializeUrl(this.currentUrlTree); } - /** The current Navigation object if one exists */ + /** + * Returns the current `Navigation` object when the router is navigating, + * and `null` when idle. + */ getCurrentNavigation(): Navigation|null { return this.currentNavigation; }