honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
This commit is contained in:
Alison Gale 2019-10-07 08:10:52 -07:00 committed by Miško Hevery
parent c8fd94ea44
commit 9c153cfb3e
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
packages/router/src/router.ts
View File

@ -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