From 9c153cfb3e2a8a0e22ae64e8f872c1908b99333e Mon Sep 17 00:00:00 2001 From: Alison Gale Date: Mon, 7 Oct 2019 08:10:52 -0700 Subject: [PATCH] docs(router): clarify that createUrlTree only uses some NavigationExtras (#33029) There is some confusion around which `NavigationExtras` values are used by createUrlTree. This specifies that only values that change the URL are used. This came up during the discussion in #27148. PR Close #33029 --- packages/router/src/router.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/router/src/router.ts b/packages/router/src/router.ts index c5466bc10b..85f48bd32e 100644 --- a/packages/router/src/router.ts +++ b/packages/router/src/router.ts @@ -867,7 +867,8 @@ export class Router { * Otherwise, applies the given command starting from the root. * * @param commands An array of commands to apply. - * @param navigationExtras Options that control the navigation strategy. + * @param navigationExtras Options that control the navigation strategy. This function + * only utilizes properties in `NavigationExtras` that would change the provided URL. * @returns The new URL tree. * * @usageNotes