From 17d47ed32fdbe6331d0ba03f9aa50f3d51cb67ab Mon Sep 17 00:00:00 2001
From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Wed, 21 Feb 2024 12:13:42 +0100
Subject: [PATCH] chore: comment

---
 packages/router/src/errors.ts | 6 ++++++
 1 file changed, 6 insertions(+)

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