chore: api docs

diff --git a/src/types/index.ts b/src/types/index.ts
index ddfd0dc1187147cd3b6de1f66d177de50ef6b794..1d386270e6e24d16a9c6228bdfd7eeeb9023d66e 100644 (file)
--- a/src/types/index.ts
+++ b/src/types/index.ts
@@ -89,13 +89,18 @@ export interface LocationAsRelative<
     : RouteParams
 }
 
+/**
+ * Common options for all navigation methods.
+ */
 export interface RouteLocationOptions {
   /**
    * Replace the entry in the history instead of pushing a new entry
    */
   replace?: boolean
   /**
-   * Triggers the navigation even if the location is the same as the current one
+   * Triggers the navigation even if the location is the same as the current one.
+   * Note this will also add a new entry to the history unless `replace: true`
+   * is passed.
    */
   force?: boolean
   /**