chore: comment

vuejs · Feb 21, 2024 · 17d47ed · 17d47ed
1 parent c9f3e0c
commit 17d47ed
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/router/src/errors.ts b/packages/router/src/errors.ts
@@ -115,6 +115,12 @@ const ErrorTypeMessages = {
 // Possible internal errors
 type RouterError = NavigationFailure | NavigationRedirectError | MatcherError
 
+/**
+ * Creates a typed NavigationFailure object.
+ * @internal
+ * @param type - NavigationFailureType
+ * @param params - { from, to }
+ */
 export function createRouterError<E extends RouterError>(
   type: E['type'],
   params: Omit<E, 'type' | keyof Error>