From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Wed, 5 Jul 2023 13:30:05 +0000 (+0200)
Subject: docs: undefined path
X-Git-Tag: v4.3.0~37
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=2607045f549dd134fdf860835207812e2b5cfcb5;p=thirdparty%2Fvuejs%2Frouter.git

docs: undefined path
---

diff --git a/packages/router/src/types/index.ts b/packages/router/src/types/index.ts
index b7e88db1..9c2396b2 100644
--- 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
 }