refactor(types): Rename ScrollBehavior to RouterScrollBehavior

posva · posva · commit 9fc09969db85 · 2020-09-10T17:24:34.000+02:00
BREAKING CHANGE: there is already an existing type named `ScrollBehavior`,
so we are renaming our type to avoid any confusions and allow the user
to use both types at the same type (which given what the existing
`ScrollBehavior` type is designed for, will likely happen).
diff --git a/src/index.ts b/src/index.ts
@@ -41,7 +41,7 @@ export {
   Router,
   RouterOptions,
   ErrorHandler,
-  ScrollBehavior,
+  RouterScrollBehavior,
 } from './router'
 
 export {
diff --git a/src/router.ts b/src/router.ts
@@ -68,7 +68,10 @@ type OnReadyCallback = [() => void, (reason?: any) => void]
 
 type Awaitable<T> = T | Promise<T>
 
-export interface ScrollBehavior {
+/**
+ * Type of the `scrollBehavior` option that can be passed to `createRouter`.
+ */
+export interface RouterScrollBehavior {
   /**
    * @param to - Route location where we are navigating to
    * @param from - Route location where we are navigating from
@@ -114,7 +117,7 @@ export interface RouterOptions extends PathParserOptions {
    * }
    * ```
    */
-  scrollBehavior?: ScrollBehavior
+  scrollBehavior?: RouterScrollBehavior
   /**
    * Custom implementation to parse a query. See its counterpart,
    * {@link RouterOptions.stringifyQuery}.
