docs: ensure we guard all navigateTo examples (nuxt#20678)

huang-julien · May 4, 2023 · 8c75961 · 8c75961
1 parent 30132f3
commit 8c75961
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 6 deletions.
diff --git a/docs/2.guide/2.directory-structure/1.middleware.md b/docs/2.guide/2.directory-structure/1.middleware.md
@@ -30,7 +30,9 @@ export default defineNuxtRouteMiddleware((to, from) => {
   if (to.params.id === '1') {
     return abortNavigation()
   }
-  return navigateTo('/')
+  if (to.path !== '/') {
+    return navigateTo('/')
+  }
 })
 ```
 

diff --git a/docs/3.api/3.utils/abort-navigation.md b/docs/3.api/3.utils/abort-navigation.md
@@ -36,7 +36,9 @@ export default defineNuxtRouteMiddleware((to, from) => {
     return abortNavigation()
   }
 
-  return navigateTo('/edit-post')
+  if (to.path !== '/edit-post') {
+    return navigateTo('/edit-post')
+  }
 })
 ```
 

diff --git a/docs/3.api/3.utils/define-nuxt-route-middleware.md b/docs/3.api/3.utils/define-nuxt-route-middleware.md
@@ -56,7 +56,9 @@ export default defineNuxtRouteMiddleware((to, from) => {
     return navigateTo('/login')
   }
 
-  return navigateTo('/dashboard')
+  if (to.path !== '/dashboard') {
+    return navigateTo('/dashboard')
+  }
 })
 ```
 

diff --git a/docs/3.api/3.utils/define-page-meta.md b/docs/3.api/3.utils/define-page-meta.md
@@ -144,7 +144,9 @@ The example below shows how the middleware can be defined using a `function` dir
             return navigateTo('/login')
         }
 
-        return navigateTo('/checkout')
+        if (to.path !== '/checkout') {
+          return navigateTo('/checkout')
+        }
       }
     ],
 

diff --git a/docs/3.api/3.utils/navigate-to.md b/docs/3.api/3.utils/navigate-to.md
@@ -96,8 +96,10 @@ await navigateTo({
 
 ```ts
 export default defineNuxtRouteMiddleware((to, from) => {
-  // setting the redirect code to '301 Moved Permanently'
-  return navigateTo('/search', { redirectCode: 301 })
+  if (to.path !== '/search') {
+    // setting the redirect code to '301 Moved Permanently'
+    return navigateTo('/search', { redirectCode: 301 })
+  }
 })
 ```