From 728b5649439e3bb65f92f4d3b7cbf83710f39b82 Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Fri, 10 Jun 2022 11:29:36 +0200 Subject: [PATCH] chore: doc function --- packages/router/src/devtools.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/packages/router/src/devtools.ts b/packages/router/src/devtools.ts index ea20cdca..c135a85b 100644 --- a/packages/router/src/devtools.ts +++ b/packages/router/src/devtools.ts @@ -19,6 +19,13 @@ import { RouterViewDevtoolsContext } from './RouterView' import { RouteLocationNormalized } from './types' import { assign, isArray } from './utils' +/** + * Copies a route location and removes any problematic properties that cannot be shown in devtools (e.g. Vue instances). + * + * @param routeLocation - routeLocation to format + * @param tooltip - optional tooltip + * @returns a copy of the routeLocation + */ function formatRouteLocation( routeLocation: RouteLocationNormalized, tooltip?: string -- 2.47.2