Skip to content
This repository was archived by the owner on Apr 6, 2023. It is now read-only.

docs(navigate-to): use await instead of return #7734

Merged
atinux merged 2 commits into from
Sep 22, 2022
Merged

docs(navigate-to): use await instead of return #7734

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d56727
docs: :memo: Use await instead of return
TheDutchCoder Sep 21, 2022
7b4db06
docs: unindent code examples
TheDutchCoder Sep 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/content/3.api/3.utils/navigate-to.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,13 @@ An object accepting the following properties:
```vue
<script setup>
// passing 'to' as a string
return navigateTo('/search')
await navigateTo('/search')

// ... or as a route object
return navigateTo({ path: '/search' })
await navigateTo({ path: '/search' })

// ... or as a route object with query parameters
return navigateTo({
await navigateTo({
path: '/search',
query: {
page: 1,
Expand All @@ -103,13 +103,13 @@ export default defineNuxtRouteMiddleware((to, from) => {

```vue
<script setup>
// will throw an error;
// navigating to an external URL is not allowed by default
await navigateTo('https://v3.nuxtjs.org')

// will redirect successfully with the 'external' parameter set to 'true'
await navigateTo('https://v3.nuxtjs.org', {
external: true
})
// will throw an error;
// navigating to an external URL is not allowed by default
await navigateTo('https://v3.nuxtjs.org')

// will redirect successfully with the 'external' parameter set to 'true'
await navigateTo('https://v3.nuxtjs.org', {
external: true
})
</script>
```