docs: undefined path

diff --git a/packages/router/src/types/index.ts b/packages/router/src/types/index.ts
index b7e88db138acc4d82a95750f4b723e1abfaaf6da..9c2396b21ce92b92f35f9b8f16098aab3766370d 100644 (file)
--- a/packages/router/src/types/index.ts
+++ b/packages/router/src/types/index.ts
@@ -59,6 +59,9 @@ export interface MatcherLocationAsPath {
 export interface MatcherLocationAsName {
   name: RouteRecordName
   // to allow checking location.path == null
+  /**
+   * Ignored path property since we are dealing with a relative location. Only `undefined` is allowed.
+   */
   path?: undefined
   params?: RouteParams
 }
@@ -68,6 +71,9 @@ export interface MatcherLocationAsName {
  */
 export interface MatcherLocationAsRelative {
   // to allow checking location.path == null
+  /**
+   * Ignored path property since we are dealing with a relative location. Only `undefined` is allowed.
+   */
   path?: undefined
   params?: RouteParams
 }
@@ -78,6 +84,9 @@ export interface MatcherLocationAsRelative {
 export interface LocationAsRelativeRaw {
   name?: RouteRecordName
   // to allow checking location.path == null
+  /**
+   * Ignored path property since we are dealing with a relative location. Only `undefined` is allowed.
+   */
   path?: undefined
   params?: RouteParamsRaw
 }