From a8242aba9bb3d4d5cea56ca853538aeafd46b58a Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Tue, 7 Jun 2022 14:29:04 +0200 Subject: [PATCH] chore: api docs --- src/types/index.ts | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) 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 /** -- 2.47.2