chore: add notes

diff --git a/packages/router/src/types/index.ts b/packages/router/src/types/index.ts
index 9860e67108985002a25a7bcccf5aaa95ce0a8764..76588f71331eba5549ca17474f06afa9905c9f43 100644 (file)
--- a/packages/router/src/types/index.ts
+++ b/packages/router/src/types/index.ts
@@ -490,6 +490,7 @@ export type NavigationGuardReturn =
   | Error
   | RouteLocationRaw
   | boolean
+  // FIXME: this one is only allowed in options api
   | NavigationGuardNextCallback
 
 /**
@@ -502,6 +503,7 @@ export interface NavigationGuard {
     to: RouteLocationNormalized,
     from: RouteLocationNormalized,
     next: NavigationGuardNext
+    // FIXME: this one shouldn't allow returning () => ...
   ): NavigationGuardReturn | Promise<NavigationGuardReturn>
 }