From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Tue, 7 Jun 2022 12:29:04 +0000 (+0200)
Subject: chore: api docs
X-Git-Tag: v4.1.0~86
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a8242aba9bb3d4d5cea56ca853538aeafd46b58a;p=thirdparty%2Fvuejs%2Frouter.git

chore: api docs
---

diff --git a/src/types/index.ts b/src/types/index.ts
index ddfd0dc1..1d386270 100644
--- 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
   /**