From 2607045f549dd134fdf860835207812e2b5cfcb5 Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Wed, 5 Jul 2023 15:30:05 +0200 Subject: [PATCH] docs: undefined path --- packages/router/src/types/index.ts | 9 +++++++++ 1 file changed, 9 insertions(+) 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 } -- 2.47.3