From 575f537473967942635821a8cb417cd3fdd5c21a Mon Sep 17 00:00:00 2001
From: josemontespg <64992551+josemontespg@users.noreply.github.com>
Date: Thu, 1 Apr 2021 15:57:58 -0300
Subject: [PATCH] docs(router): make getCurrentNavigation() jsdoc more explicit
 (#41417)

Add additional clarification to the documentation for
`getCurrentNavigation`.

PR Close #41417
---
 packages/router/src/router.ts | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

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;
   }