docs(router): document segment consumption during route evaluation (#58069)

nesjett · alxhub · commit e638b292f244 · 2024-10-24T12:41:39.000-07:00
PR Close #58069
diff --git a/packages/router/src/models.ts b/packages/router/src/models.ts
@@ -1115,6 +1115,9 @@ export interface CanMatch {
  *
  * {@example router/route_functional_guards.ts region="CanMatchFn"}
  *
+ * @param route The route configuration.
+ * @param segments The URL segments that have not been consumed by previous parent route evaluations.
+ *
  * @publicApi
  * @see {@link Route}
  */

Original file line number	Diff line number	Diff line change
`@@ -1115,6 +1115,9 @@ export interface CanMatch {`
`1115`	`1115`	`*`
`1116`	`1116`	`* {@example router/route_functional_guards.ts region="CanMatchFn"}`
`1117`	`1117`	`*`
	`1118`	`+ * @param route The route configuration.`
	`1119`	`+ * @param segments The URL segments that have not been consumed by previous parent route evaluations.`
	`1120`	`+ *`
`1118`	`1121`	`* @publicApi`
`1119`	`1122`	`* @see {@link Route}`
`1120`	`1123`	`*/`