]> git.ipfire.org Git - thirdparty/vuejs/router.git/commitdiff
chore: doc function
authorEduardo San Martin Morote <posva13@gmail.com>
Fri, 10 Jun 2022 09:29:36 +0000 (11:29 +0200)
committerEduardo San Martin Morote <posva@users.noreply.github.com>
Thu, 30 Jun 2022 07:59:00 +0000 (09:59 +0200)
packages/router/src/devtools.ts

index ea20cdca2a6b5ea1e0fd19fbfc49de45a4c83366..c135a85b0b8610a44973cc6833ac0939ca0658c3 100644 (file)
@@ -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