chore: comment

diff --git a/packages/router/src/errors.ts b/packages/router/src/errors.ts
index 379bf6392ca04839a2384f677c508d86df5fdcc5..021e7a8bb562c60e448ffcaeedbd79018d7c8eef 100644 (file)
--- 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>