From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Wed, 21 Feb 2024 11:13:42 +0000 (+0100)
Subject: chore: comment
X-Git-Tag: v4.3.0~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=17d47ed32fdbe6331d0ba03f9aa50f3d51cb67ab;p=thirdparty%2Fvuejs%2Frouter.git

chore: comment
---

diff --git a/packages/router/src/errors.ts b/packages/router/src/errors.ts
index 379bf639..021e7a8b 100644
--- 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>