@nuxt/docs 4.1.2 → 4.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/1.getting-started/01.introduction.md +6 -6
- package/1.getting-started/02.installation.md +2 -1
- package/1.getting-started/03.configuration.md +36 -36
- package/1.getting-started/04.views.md +9 -9
- package/1.getting-started/05.assets.md +15 -9
- package/1.getting-started/06.styling.md +58 -48
- package/1.getting-started/07.routing.md +17 -17
- package/1.getting-started/08.seo-meta.md +59 -46
- package/1.getting-started/09.transitions.md +49 -44
- package/1.getting-started/10.data-fetching.md +104 -81
- package/1.getting-started/11.state-management.md +26 -19
- package/1.getting-started/12.error-handling.md +22 -20
- package/1.getting-started/13.server.md +8 -8
- package/1.getting-started/14.layers.md +22 -16
- package/1.getting-started/15.prerendering.md +32 -32
- package/1.getting-started/16.deployment.md +10 -10
- package/1.getting-started/17.testing.md +44 -44
- package/1.getting-started/18.upgrade.md +53 -71
- package/2.guide/0.index.md +7 -7
- package/2.guide/{2.directory-structure → 1.directory-structure}/.navigation.yml +1 -1
- package/2.guide/{2.directory-structure → 1.directory-structure}/0.nuxt.md +3 -3
- package/2.guide/1.directory-structure/0.output.md +18 -0
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.app/.navigation.yml +1 -1
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.app/1.assets.md +4 -4
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.app/1.components.md +45 -28
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.app/1.composables.md +13 -13
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.app/1.layouts.md +19 -15
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.app/1.middleware.md +31 -25
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.app/1.pages.md +39 -37
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.app/1.plugins.md +25 -25
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.app/1.utils.md +7 -7
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.app/3.app-config.md +18 -18
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.app/3.app.md +7 -7
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.app/3.error.md +6 -6
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.content.md +7 -4
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.modules.md +8 -8
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.node_modules.md +2 -2
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.public.md +2 -2
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.server.md +35 -35
- package/2.guide/{2.directory-structure → 1.directory-structure}/1.shared.md +7 -7
- package/2.guide/{2.directory-structure → 1.directory-structure}/2.env.md +8 -8
- package/2.guide/{2.directory-structure → 1.directory-structure}/2.gitignore.md +1 -1
- package/2.guide/{2.directory-structure → 1.directory-structure}/2.nuxtignore.md +5 -4
- package/2.guide/{2.directory-structure → 1.directory-structure}/2.nuxtrc.md +4 -4
- package/2.guide/{2.directory-structure → 1.directory-structure}/3.nuxt-config.md +3 -3
- package/2.guide/{2.directory-structure → 1.directory-structure}/3.package.md +1 -1
- package/2.guide/{2.directory-structure → 1.directory-structure}/3.tsconfig.md +3 -3
- package/2.guide/{1.concepts → 2.concepts}/1.auto-imports.md +22 -22
- package/2.guide/{1.concepts → 2.concepts}/10.nuxt-lifecycle.md +17 -17
- package/2.guide/{1.concepts → 2.concepts}/2.vuejs-development.md +13 -13
- package/2.guide/{1.concepts → 2.concepts}/3.rendering.md +24 -22
- package/2.guide/{1.concepts → 2.concepts}/4.server-engine.md +6 -6
- package/2.guide/{1.concepts → 2.concepts}/5.modules.md +5 -5
- package/2.guide/{1.concepts → 2.concepts}/7.esm.md +17 -15
- package/2.guide/{1.concepts → 2.concepts}/8.typescript.md +12 -12
- package/2.guide/3.going-further/1.events.md +3 -3
- package/2.guide/3.going-further/1.experimental-features.md +246 -85
- package/2.guide/3.going-further/1.features.md +44 -9
- package/2.guide/3.going-further/1.internals.md +25 -25
- package/2.guide/3.going-further/10.runtime-config.md +12 -12
- package/2.guide/3.going-further/11.nightly-release-channel.md +1 -1
- package/2.guide/3.going-further/2.hooks.md +14 -14
- package/2.guide/3.going-further/3.modules.md +96 -94
- package/2.guide/3.going-further/4.kit.md +7 -7
- package/2.guide/3.going-further/6.nuxt-app.md +8 -8
- package/2.guide/3.going-further/7.layers.md +62 -53
- package/2.guide/3.going-further/9.debugging.md +2 -2
- package/2.guide/4.recipes/1.custom-routing.md +30 -30
- package/2.guide/4.recipes/2.vite-plugin.md +4 -4
- package/2.guide/4.recipes/3.custom-usefetch.md +13 -13
- package/2.guide/4.recipes/4.sessions-and-authentication.md +35 -21
- package/2.guide/5.best-practices/hydration.md +4 -4
- package/2.guide/5.best-practices/performance.md +17 -17
- package/3.api/1.components/1.client-only.md +6 -3
- package/3.api/1.components/1.nuxt-client-fallback.md +10 -7
- package/3.api/1.components/10.nuxt-picture.md +1 -1
- package/3.api/1.components/11.teleports.md +5 -2
- package/3.api/1.components/12.nuxt-route-announcer.md +9 -9
- package/3.api/1.components/13.nuxt-time.md +44 -17
- package/3.api/1.components/2.nuxt-page.md +6 -6
- package/3.api/1.components/3.nuxt-layout.md +15 -10
- package/3.api/1.components/4.nuxt-link.md +42 -22
- package/3.api/1.components/5.nuxt-loading-indicator.md +3 -3
- package/3.api/1.components/6.nuxt-error-boundary.md +12 -10
- package/3.api/2.composables/on-prehydrate.md +2 -2
- package/3.api/2.composables/use-app-config.md +1 -1
- package/3.api/2.composables/use-async-data.md +20 -20
- package/3.api/2.composables/use-cookie.md +29 -21
- package/3.api/2.composables/use-error.md +2 -2
- package/3.api/2.composables/use-fetch.md +58 -32
- package/3.api/2.composables/use-head-safe.md +7 -7
- package/3.api/2.composables/use-head.md +5 -5
- package/3.api/2.composables/use-hydration.md +6 -6
- package/3.api/2.composables/use-lazy-async-data.md +4 -4
- package/3.api/2.composables/use-lazy-fetch.md +4 -4
- package/3.api/2.composables/use-loading-indicator.md +12 -12
- package/3.api/2.composables/use-nuxt-app.md +22 -22
- package/3.api/2.composables/use-nuxt-data.md +8 -8
- package/3.api/2.composables/use-preview-mode.md +15 -18
- package/3.api/2.composables/use-request-event.md +1 -1
- package/3.api/2.composables/use-request-fetch.md +3 -3
- package/3.api/2.composables/use-request-header.md +1 -1
- package/3.api/2.composables/use-request-headers.md +4 -4
- package/3.api/2.composables/use-request-url.md +1 -1
- package/3.api/2.composables/use-response-header.md +9 -10
- package/3.api/2.composables/use-route-announcer.md +4 -4
- package/3.api/2.composables/use-route.md +1 -1
- package/3.api/2.composables/use-router.md +10 -8
- package/3.api/2.composables/use-runtime-config.md +11 -11
- package/3.api/2.composables/use-runtime-hook.md +2 -2
- package/3.api/2.composables/use-seo-meta.md +4 -4
- package/3.api/2.composables/use-server-seo-meta.md +6 -6
- package/3.api/2.composables/use-state.md +5 -5
- package/3.api/3.utils/$fetch.md +10 -8
- package/3.api/3.utils/abort-navigation.md +3 -3
- package/3.api/3.utils/add-route-middleware.md +5 -5
- package/3.api/3.utils/call-once.md +6 -6
- package/3.api/3.utils/clear-error.md +3 -3
- package/3.api/3.utils/clear-nuxt-data.md +3 -3
- package/3.api/3.utils/clear-nuxt-state.md +3 -3
- package/3.api/3.utils/create-error.md +2 -2
- package/3.api/3.utils/define-lazy-hydration-component.md +13 -13
- package/3.api/3.utils/define-nuxt-component.md +5 -5
- package/3.api/3.utils/define-nuxt-plugin.md +13 -13
- package/3.api/3.utils/define-nuxt-route-middleware.md +5 -5
- package/3.api/3.utils/define-page-meta.md +23 -23
- package/3.api/3.utils/define-route-rules.md +7 -7
- package/3.api/3.utils/navigate-to.md +11 -11
- package/3.api/3.utils/prefetch-components.md +1 -1
- package/3.api/3.utils/preload-components.md +1 -1
- package/3.api/3.utils/preload-route-components.md +2 -2
- package/3.api/3.utils/prerender-routes.md +3 -3
- package/3.api/3.utils/refresh-cookie.md +4 -4
- package/3.api/3.utils/refresh-nuxt-data.md +12 -7
- package/3.api/3.utils/reload-nuxt-app.md +3 -3
- package/3.api/3.utils/set-page-layout.md +1 -1
- package/3.api/3.utils/set-response-status.md +3 -3
- package/3.api/3.utils/show-error.md +5 -5
- package/3.api/3.utils/update-app-config.md +4 -3
- package/3.api/4.commands/add.md +1 -1
- package/3.api/4.commands/analyze.md +2 -1
- package/3.api/4.commands/build.md +2 -1
- package/3.api/4.commands/dev.md +5 -4
- package/3.api/4.commands/generate.md +3 -2
- package/3.api/4.commands/init.md +3 -2
- package/3.api/4.commands/module.md +4 -4
- package/3.api/4.commands/prepare.md +7 -2
- package/3.api/4.commands/preview.md +5 -4
- package/3.api/4.commands/test.md +40 -0
- package/3.api/4.commands/typecheck.md +5 -3
- package/3.api/4.commands/upgrade.md +3 -3
- package/3.api/5.kit/1.modules.md +36 -36
- package/3.api/5.kit/10.runtime-config.md +1 -1
- package/3.api/5.kit/10.templates.md +8 -6
- package/3.api/5.kit/11.nitro.md +62 -62
- package/3.api/5.kit/12.resolving.md +2 -2
- package/3.api/5.kit/14.builder.md +1 -0
- package/3.api/5.kit/15.examples.md +2 -2
- package/3.api/5.kit/16.layers.md +26 -26
- package/3.api/5.kit/3.compatibility.md +14 -14
- package/3.api/5.kit/4.autoimports.md +13 -13
- package/3.api/5.kit/5.components.md +7 -7
- package/3.api/5.kit/6.context.md +3 -3
- package/3.api/5.kit/7.pages.md +7 -7
- package/3.api/5.kit/8.layout.md +2 -2
- package/3.api/5.kit/9.plugins.md +5 -4
- package/3.api/6.advanced/1.hooks.md +3 -3
- package/3.api/6.advanced/2.import-meta.md +3 -3
- package/3.api/6.nuxt-config.md +300 -865
- package/3.api/index.md +7 -7
- package/5.community/2.getting-help.md +1 -1
- package/5.community/3.reporting-bugs.md +1 -1
- package/5.community/4.contribution.md +11 -11
- package/5.community/5.framework-contribution.md +4 -4
- package/5.community/6.roadmap.md +1 -1
- package/6.bridge/1.overview.md +13 -13
- package/6.bridge/10.configuration.md +2 -1
- package/6.bridge/2.typescript.md +3 -3
- package/6.bridge/3.bridge-composition-api.md +8 -8
- package/6.bridge/4.plugins-and-middleware.md +9 -9
- package/6.bridge/5.nuxt3-compatible-api.md +20 -17
- package/6.bridge/6.meta.md +20 -19
- package/6.bridge/7.runtime-config.md +1 -1
- package/6.bridge/8.nitro.md +3 -3
- package/6.bridge/9.vite.md +4 -4
- package/7.migration/1.overview.md +2 -2
- package/7.migration/10.bundling.md +1 -1
- package/7.migration/11.server.md +3 -3
- package/7.migration/2.configuration.md +23 -21
- package/7.migration/20.module-authors.md +7 -7
- package/7.migration/3.auto-imports.md +3 -3
- package/7.migration/4.meta.md +21 -18
- package/7.migration/5.plugins-and-middleware.md +8 -8
- package/7.migration/6.pages-and-layouts.md +28 -24
- package/7.migration/7.component-options.md +18 -18
- package/7.migration/8.runtime-config.md +7 -7
- package/package.json +1 -1
- package/2.guide/2.directory-structure/0.output.md +0 -18
- /package/2.guide/{1.concepts → 2.concepts}/.navigation.yml +0 -0
- /package/2.guide/{1.concepts → 2.concepts}/9.code-style.md +0 -0
|
@@ -22,7 +22,7 @@ export default defineEventHandler((event) => {
|
|
|
22
22
|
})
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
:read-more{to="/docs/guide/going-further/runtime-config"}
|
|
25
|
+
:read-more{to="/docs/4.x/guide/going-further/runtime-config"}
|
|
26
26
|
|
|
27
27
|
## Define Runtime Config
|
|
28
28
|
|
|
@@ -38,9 +38,9 @@ export default defineNuxtConfig({
|
|
|
38
38
|
|
|
39
39
|
// Public keys that are exposed to the client
|
|
40
40
|
public: {
|
|
41
|
-
apiBase: process.env.NUXT_PUBLIC_API_BASE || '/api'
|
|
42
|
-
}
|
|
43
|
-
}
|
|
41
|
+
apiBase: process.env.NUXT_PUBLIC_API_BASE || '/api',
|
|
42
|
+
},
|
|
43
|
+
},
|
|
44
44
|
})
|
|
45
45
|
```
|
|
46
46
|
|
|
@@ -48,7 +48,7 @@ export default defineNuxtConfig({
|
|
|
48
48
|
Variables that need to be accessible on the server are added directly inside `runtimeConfig`. Variables that need to be accessible on both the client and the server are defined in `runtimeConfig.public`.
|
|
49
49
|
::
|
|
50
50
|
|
|
51
|
-
:read-more{to="/docs/guide/going-further/runtime-config"}
|
|
51
|
+
:read-more{to="/docs/4.x/guide/going-further/runtime-config"}
|
|
52
52
|
|
|
53
53
|
## Access Runtime Config
|
|
54
54
|
|
|
@@ -63,11 +63,11 @@ export default defineEventHandler(async (event) => {
|
|
|
63
63
|
baseURL: config.public.apiBase,
|
|
64
64
|
headers: {
|
|
65
65
|
// Access a private variable (only available on the server)
|
|
66
|
-
Authorization: `Bearer ${config.apiSecret}
|
|
67
|
-
}
|
|
66
|
+
Authorization: `Bearer ${config.apiSecret}`,
|
|
67
|
+
},
|
|
68
68
|
})
|
|
69
69
|
return result
|
|
70
|
-
}
|
|
70
|
+
})
|
|
71
71
|
```
|
|
72
72
|
|
|
73
73
|
In this example, since `apiBase` is defined within the `public` namespace, it is universally accessible on both server and client-side, while `apiSecret` **is only accessible on the server-side**.
|
|
@@ -76,7 +76,7 @@ In this example, since `apiBase` is defined within the `public` namespace, it is
|
|
|
76
76
|
|
|
77
77
|
It is possible to update runtime config values using a matching environment variable name prefixed with `NUXT_`.
|
|
78
78
|
|
|
79
|
-
:read-more{to="/docs/guide/going-further/runtime-config"}
|
|
79
|
+
:read-more{to="/docs/4.x/guide/going-further/runtime-config"}
|
|
80
80
|
|
|
81
81
|
### Using the `.env` File
|
|
82
82
|
|
|
@@ -95,7 +95,7 @@ Any environment variables set within `.env` file are accessed using `process.env
|
|
|
95
95
|
In **production runtime**, you should use platform environment variables and `.env` is not used.
|
|
96
96
|
::
|
|
97
97
|
|
|
98
|
-
:read-more{to="/docs/guide/directory-structure/env"}
|
|
98
|
+
:read-more{to="/docs/4.x/guide/directory-structure/env"}
|
|
99
99
|
|
|
100
100
|
## `app` namespace
|
|
101
101
|
|
|
@@ -139,4 +139,4 @@ export default defineEventHandler((event) => {
|
|
|
139
139
|
})
|
|
140
140
|
```
|
|
141
141
|
|
|
142
|
-
:read-more{to="/docs/guide/going-further/runtime-config"}
|
|
142
|
+
:read-more{to="/docs/4.x/guide/going-further/runtime-config"}
|
|
@@ -13,7 +13,7 @@ This composable is available in Nuxt v3.14+.
|
|
|
13
13
|
::
|
|
14
14
|
|
|
15
15
|
```ts [signature]
|
|
16
|
-
function useRuntimeHook<THookName extends keyof RuntimeNuxtHooks>(
|
|
16
|
+
function useRuntimeHook<THookName extends keyof RuntimeNuxtHooks> (
|
|
17
17
|
name: THookName,
|
|
18
18
|
fn: RuntimeNuxtHooks[THookName] extends HookCallback ? RuntimeNuxtHooks[THookName] : never
|
|
19
19
|
): void
|
|
@@ -23,7 +23,7 @@ function useRuntimeHook<THookName extends keyof RuntimeNuxtHooks>(
|
|
|
23
23
|
|
|
24
24
|
### Parameters
|
|
25
25
|
|
|
26
|
-
- `name`: The name of the runtime hook to register. You can see the full list of [runtime Nuxt hooks here](/docs/api/advanced/hooks#app-hooks-runtime).
|
|
26
|
+
- `name`: The name of the runtime hook to register. You can see the full list of [runtime Nuxt hooks here](/docs/4.x/api/advanced/hooks#app-hooks-runtime).
|
|
27
27
|
- `fn`: The callback function to execute when the hook is triggered. The function signature varies based on the hook name.
|
|
28
28
|
|
|
29
29
|
### Returns
|
|
@@ -14,7 +14,7 @@ This helps you avoid common mistakes, such as using `name` instead of `property`
|
|
|
14
14
|
This is the recommended way to add meta tags to your site as it is XSS safe and has full TypeScript support.
|
|
15
15
|
::
|
|
16
16
|
|
|
17
|
-
:read-more{to="/docs/getting-started/seo-meta"}
|
|
17
|
+
:read-more{to="/docs/4.x/getting-started/seo-meta"}
|
|
18
18
|
|
|
19
19
|
## Usage
|
|
20
20
|
|
|
@@ -39,7 +39,7 @@ const title = ref('My title')
|
|
|
39
39
|
|
|
40
40
|
useSeoMeta({
|
|
41
41
|
title,
|
|
42
|
-
description: () => `This is a description for the ${title.value} page
|
|
42
|
+
description: () => `This is a description for the ${title.value} page`,
|
|
43
43
|
})
|
|
44
44
|
</script>
|
|
45
45
|
```
|
|
@@ -48,7 +48,7 @@ useSeoMeta({
|
|
|
48
48
|
|
|
49
49
|
There are over 100 parameters. See the [full list of parameters in the source code](https://github.com/harlan-zw/zhead/blob/main/packages/zhead/src/metaFlat.ts#L1035).
|
|
50
50
|
|
|
51
|
-
:read-more{to="/docs/getting-started/seo-meta"}
|
|
51
|
+
:read-more{to="/docs/4.x/getting-started/seo-meta"}
|
|
52
52
|
|
|
53
53
|
## Performance
|
|
54
54
|
|
|
@@ -77,4 +77,4 @@ useSeoMeta({
|
|
|
77
77
|
</script>
|
|
78
78
|
```
|
|
79
79
|
|
|
80
|
-
This previously used the [`useServerSeoMeta`](/docs/api/composables/use-server-seo-meta) composable, but it has been deprecated in favor of this approach.
|
|
80
|
+
This previously used the [`useServerSeoMeta`](/docs/4.x/api/composables/use-server-seo-meta) composable, but it has been deprecated in favor of this approach.
|
|
@@ -8,20 +8,20 @@ links:
|
|
|
8
8
|
size: xs
|
|
9
9
|
---
|
|
10
10
|
|
|
11
|
-
Just like [`useSeoMeta`](/docs/api/composables/use-seo-meta), `useServerSeoMeta` composable lets you define your site's SEO meta tags as a flat object with full TypeScript support.
|
|
11
|
+
Just like [`useSeoMeta`](/docs/4.x/api/composables/use-seo-meta), `useServerSeoMeta` composable lets you define your site's SEO meta tags as a flat object with full TypeScript support.
|
|
12
12
|
|
|
13
|
-
:read-more{to="/docs/api/composables/use-seo-meta"}
|
|
13
|
+
:read-more{to="/docs/4.x/api/composables/use-seo-meta"}
|
|
14
14
|
|
|
15
|
-
In most instances, the meta doesn't need to be reactive as robots will only scan the initial load. So we recommend using [`useServerSeoMeta`](/docs/api/composables/use-server-seo-meta) as a performance-focused utility that will not do anything (or return a `head` object) on the client.
|
|
15
|
+
In most instances, the meta doesn't need to be reactive as robots will only scan the initial load. So we recommend using [`useServerSeoMeta`](/docs/4.x/api/composables/use-server-seo-meta) as a performance-focused utility that will not do anything (or return a `head` object) on the client.
|
|
16
16
|
|
|
17
17
|
```vue [app/app.vue]
|
|
18
18
|
<script setup lang="ts">
|
|
19
19
|
useServerSeoMeta({
|
|
20
|
-
robots: 'index, follow'
|
|
20
|
+
robots: 'index, follow',
|
|
21
21
|
})
|
|
22
22
|
</script>
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Parameters are exactly the same as with [`useSeoMeta`](/docs/api/composables/use-seo-meta)
|
|
25
|
+
Parameters are exactly the same as with [`useSeoMeta`](/docs/4.x/api/composables/use-seo-meta)
|
|
26
26
|
|
|
27
|
-
:read-more{to="/docs/getting-started/seo-meta"}
|
|
27
|
+
:read-more{to="/docs/4.x/getting-started/seo-meta"}
|
|
@@ -15,7 +15,7 @@ links:
|
|
|
15
15
|
const count = useState('counter', () => Math.round(Math.random() * 100))
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
:read-more{to="/docs/getting-started/state-management"}
|
|
18
|
+
:read-more{to="/docs/4.x/getting-started/state-management"}
|
|
19
19
|
|
|
20
20
|
::important
|
|
21
21
|
Because the data inside `useState` will be serialized to JSON, it is important that it does not contain anything that cannot be serialized, such as classes, functions or symbols.
|
|
@@ -38,11 +38,11 @@ const state = useState('my-shallow-state', () => shallowRef({ deep: 'not reactiv
|
|
|
38
38
|
|
|
39
39
|
## Type
|
|
40
40
|
|
|
41
|
-
```ts
|
|
42
|
-
useState<T>(init?: () => T | Ref<T>): Ref<T>
|
|
43
|
-
useState<T>(key: string, init?: () => T | Ref<T>): Ref<T>
|
|
41
|
+
```ts [Signature]
|
|
42
|
+
export function useState<T> (init?: () => T | Ref<T>): Ref<T>
|
|
43
|
+
export function useState<T> (key: string, init?: () => T | Ref<T>): Ref<T>
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
- `key`: A unique key ensuring that data fetching is properly de-duplicated across requests. If you do not provide a key, then a key that is unique to the file and line number of the instance of [`useState`](/docs/api/composables/use-state) will be generated for you.
|
|
46
|
+
- `key`: A unique key ensuring that data fetching is properly de-duplicated across requests. If you do not provide a key, then a key that is unique to the file and line number of the instance of [`useState`](/docs/4.x/api/composables/use-state) will be generated for you.
|
|
47
47
|
- `init`: A function that provides initial value for the state when not initiated. This function can also return a `Ref`.
|
|
48
48
|
- `T`: (typescript only) Specify the type of state
|
package/3.api/3.utils/$fetch.md
CHANGED
|
@@ -11,16 +11,16 @@ links:
|
|
|
11
11
|
Nuxt uses [ofetch](https://github.com/unjs/ofetch) to expose globally the `$fetch` helper for making HTTP requests within your Vue app or API routes.
|
|
12
12
|
|
|
13
13
|
::tip{icon="i-lucide-rocket"}
|
|
14
|
-
During server-side rendering, calling `$fetch` to fetch your internal [API routes](/docs/guide/directory-structure/server) will directly call the relevant function (emulating the request), **saving an additional API call**.
|
|
14
|
+
During server-side rendering, calling `$fetch` to fetch your internal [API routes](/docs/4.x/guide/directory-structure/server) will directly call the relevant function (emulating the request), **saving an additional API call**.
|
|
15
15
|
::
|
|
16
16
|
|
|
17
17
|
::note{color="blue" icon="i-lucide-info"}
|
|
18
|
-
Using `$fetch` in components without wrapping it with [`useAsyncData`](/docs/api/composables/use-async-data) causes fetching the data twice: initially on the server, then again on the client-side during hydration, because `$fetch` does not transfer state from the server to the client. Thus, the fetch will be executed on both sides because the client has to get the data again.
|
|
18
|
+
Using `$fetch` in components without wrapping it with [`useAsyncData`](/docs/4.x/api/composables/use-async-data) causes fetching the data twice: initially on the server, then again on the client-side during hydration, because `$fetch` does not transfer state from the server to the client. Thus, the fetch will be executed on both sides because the client has to get the data again.
|
|
19
19
|
::
|
|
20
20
|
|
|
21
21
|
## Usage
|
|
22
22
|
|
|
23
|
-
We recommend using [`useFetch`](/docs/api/composables/use-fetch) or [`useAsyncData`](/docs/api/composables/use-async-data) + `$fetch` to prevent double data fetching when fetching the component data.
|
|
23
|
+
We recommend using [`useFetch`](/docs/4.x/api/composables/use-fetch) or [`useAsyncData`](/docs/4.x/api/composables/use-async-data) + `$fetch` to prevent double data fetching when fetching the component data.
|
|
24
24
|
|
|
25
25
|
```vue [app/app.vue]
|
|
26
26
|
<script setup lang="ts">
|
|
@@ -35,22 +35,24 @@ const { data } = await useFetch('/api/item')
|
|
|
35
35
|
</script>
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
:read-more{to="/docs/getting-started/data-fetching"}
|
|
38
|
+
:read-more{to="/docs/4.x/getting-started/data-fetching"}
|
|
39
39
|
|
|
40
40
|
You can use `$fetch` in any methods that are executed only on client-side.
|
|
41
41
|
|
|
42
42
|
```vue [app/pages/contact.vue]
|
|
43
43
|
<script setup lang="ts">
|
|
44
|
-
async function contactForm() {
|
|
44
|
+
async function contactForm () {
|
|
45
45
|
await $fetch('/api/contact', {
|
|
46
46
|
method: 'POST',
|
|
47
|
-
body: { hello: 'world
|
|
47
|
+
body: { hello: 'world' },
|
|
48
48
|
})
|
|
49
49
|
}
|
|
50
50
|
</script>
|
|
51
51
|
|
|
52
52
|
<template>
|
|
53
|
-
<button @click="contactForm">
|
|
53
|
+
<button @click="contactForm">
|
|
54
|
+
Contact
|
|
55
|
+
</button>
|
|
54
56
|
</template>
|
|
55
57
|
```
|
|
56
58
|
|
|
@@ -95,4 +97,4 @@ const { data } = await useAsyncData(() => requestFetch('/api/cookies'))
|
|
|
95
97
|
</script>
|
|
96
98
|
```
|
|
97
99
|
|
|
98
|
-
However, when calling `useFetch` with a relative URL on the server, Nuxt will use [`useRequestFetch`](/docs/api/composables/use-request-fetch) to proxy headers and cookies (with the exception of headers not meant to be forwarded, like `host`).
|
|
100
|
+
However, when calling `useFetch` with a relative URL on the server, Nuxt will use [`useRequestFetch`](/docs/4.x/api/composables/use-request-fetch) to proxy headers and cookies (with the exception of headers not meant to be forwarded, like `host`).
|
|
@@ -9,13 +9,13 @@ links:
|
|
|
9
9
|
---
|
|
10
10
|
|
|
11
11
|
::warning
|
|
12
|
-
`abortNavigation` is only usable inside a [route middleware handler](/docs/guide/directory-structure/app/middleware).
|
|
12
|
+
`abortNavigation` is only usable inside a [route middleware handler](/docs/4.x/guide/directory-structure/app/middleware).
|
|
13
13
|
::
|
|
14
14
|
|
|
15
15
|
## Type
|
|
16
16
|
|
|
17
|
-
```ts
|
|
18
|
-
abortNavigation(err?: Error | string): false
|
|
17
|
+
```ts [Signature]
|
|
18
|
+
export function abortNavigation (err?: Error | string): false
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
## Parameters
|
|
@@ -9,7 +9,7 @@ links:
|
|
|
9
9
|
---
|
|
10
10
|
|
|
11
11
|
::note
|
|
12
|
-
Route middleware are navigation guards stored in the [`app/middleware/`](/docs/guide/directory-structure/app/middleware) directory of your Nuxt application (unless [set otherwise](/docs/api/nuxt-config#middleware)).
|
|
12
|
+
Route middleware are navigation guards stored in the [`app/middleware/`](/docs/4.x/guide/directory-structure/app/middleware) directory of your Nuxt application (unless [set otherwise](/docs/4.x/api/nuxt-config#middleware)).
|
|
13
13
|
::
|
|
14
14
|
|
|
15
15
|
## Type
|
|
@@ -31,7 +31,7 @@ interface AddRouteMiddlewareOptions {
|
|
|
31
31
|
|
|
32
32
|
Can be either a string or a function of type `RouteMiddleware`. Function takes the next route `to` as the first argument and the current route `from` as the second argument, both of which are Vue route objects.
|
|
33
33
|
|
|
34
|
-
Learn more about available properties of [route objects](/docs/api/composables/use-route).
|
|
34
|
+
Learn more about available properties of [route objects](/docs/4.x/api/composables/use-route).
|
|
35
35
|
|
|
36
36
|
### `middleware`
|
|
37
37
|
|
|
@@ -80,9 +80,9 @@ Global route middleware can be defined in two ways:
|
|
|
80
80
|
```ts [app/plugins/my-plugin.ts]
|
|
81
81
|
export default defineNuxtPlugin(() => {
|
|
82
82
|
addRouteMiddleware('global-middleware', (to, from) => {
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
83
|
+
console.log('global middleware that runs on every route change')
|
|
84
|
+
},
|
|
85
|
+
{ global: true },
|
|
86
86
|
)
|
|
87
87
|
})
|
|
88
88
|
```
|
|
@@ -54,14 +54,14 @@ await callOnce(async () => {
|
|
|
54
54
|
`navigation` mode is available since [Nuxt v3.15](/blog/v3-15).
|
|
55
55
|
::
|
|
56
56
|
|
|
57
|
-
::tip{to="/docs/getting-started/state-management#usage-with-pinia"}
|
|
57
|
+
::tip{to="/docs/4.x/getting-started/state-management#usage-with-pinia"}
|
|
58
58
|
`callOnce` is useful in combination with the [Pinia module](/modules/pinia) to call store actions.
|
|
59
59
|
::
|
|
60
60
|
|
|
61
|
-
:read-more{to="/docs/getting-started/state-management"}
|
|
61
|
+
:read-more{to="/docs/4.x/getting-started/state-management"}
|
|
62
62
|
|
|
63
63
|
::warning
|
|
64
|
-
Note that `callOnce` doesn't return anything. You should use [`useAsyncData`](/docs/api/composables/use-async-data) or [`useFetch`](/docs/api/composables/use-fetch) if you want to do data fetching during SSR.
|
|
64
|
+
Note that `callOnce` doesn't return anything. You should use [`useAsyncData`](/docs/4.x/api/composables/use-async-data) or [`useFetch`](/docs/4.x/api/composables/use-fetch) if you want to do data fetching during SSR.
|
|
65
65
|
::
|
|
66
66
|
|
|
67
67
|
::note
|
|
@@ -70,9 +70,9 @@ Note that `callOnce` doesn't return anything. You should use [`useAsyncData`](/d
|
|
|
70
70
|
|
|
71
71
|
## Type
|
|
72
72
|
|
|
73
|
-
```ts
|
|
74
|
-
callOnce (key?: string, fn?: (() => any | Promise<any>), options?: CallOnceOptions): Promise<void>
|
|
75
|
-
callOnce(fn?: (() => any | Promise<any>), options?: CallOnceOptions): Promise<void>
|
|
73
|
+
```ts [Signature]
|
|
74
|
+
export function callOnce (key?: string, fn?: (() => any | Promise<any>), options?: CallOnceOptions): Promise<void>
|
|
75
|
+
export function callOnce (fn?: (() => any | Promise<any>), options?: CallOnceOptions): Promise<void>
|
|
76
76
|
|
|
77
77
|
type CallOnceOptions = {
|
|
78
78
|
/**
|
|
@@ -16,7 +16,7 @@ Within your pages, components, and plugins, you can use `clearError` to clear al
|
|
|
16
16
|
|
|
17
17
|
You can provide an optional path to redirect to (for example, if you want to navigate to a 'safe' page).
|
|
18
18
|
|
|
19
|
-
```
|
|
19
|
+
```ts
|
|
20
20
|
// Without redirect
|
|
21
21
|
clearError()
|
|
22
22
|
|
|
@@ -24,6 +24,6 @@ clearError()
|
|
|
24
24
|
clearError({ redirect: '/homepage' })
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
Errors are set in state using [`useError()`](/docs/api/composables/use-error). The `clearError` composable will reset this state and calls the `app:error:cleared` hook with the provided options.
|
|
27
|
+
Errors are set in state using [`useError()`](/docs/4.x/api/composables/use-error). The `clearError` composable will reset this state and calls the `app:error:cleared` hook with the provided options.
|
|
28
28
|
|
|
29
|
-
:read-more{to="/docs/getting-started/error-handling"}
|
|
29
|
+
:read-more{to="/docs/4.x/getting-started/error-handling"}
|
|
@@ -14,10 +14,10 @@ This method is useful if you want to invalidate the data fetching for another pa
|
|
|
14
14
|
|
|
15
15
|
## Type
|
|
16
16
|
|
|
17
|
-
```ts
|
|
18
|
-
clearNuxtData (keys?: string | string[] | ((key: string) => boolean)): void
|
|
17
|
+
```ts [Signature]
|
|
18
|
+
export function clearNuxtData (keys?: string | string[] | ((key: string) => boolean)): void
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
## Parameters
|
|
22
22
|
|
|
23
|
-
* `keys`: One or an array of keys that are used in [`useAsyncData`](/docs/api/composables/use-async-data) to delete their cached data. If no keys are provided, **all data** will be invalidated.
|
|
23
|
+
* `keys`: One or an array of keys that are used in [`useAsyncData`](/docs/4.x/api/composables/use-async-data) to delete their cached data. If no keys are provided, **all data** will be invalidated.
|
|
@@ -14,10 +14,10 @@ This method is useful if you want to invalidate the state of `useState`.
|
|
|
14
14
|
|
|
15
15
|
## Type
|
|
16
16
|
|
|
17
|
-
```ts
|
|
18
|
-
clearNuxtState (keys?: string | string[] | ((key: string) => boolean)): void
|
|
17
|
+
```ts [Signature]
|
|
18
|
+
export function clearNuxtState (keys?: string | string[] | ((key: string) => boolean)): void
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
## Parameters
|
|
22
22
|
|
|
23
|
-
- `keys`: One or an array of keys that are used in [`useState`](/docs/api/composables/use-state) to delete their cached state. If no keys are provided, **all state** will be invalidated.
|
|
23
|
+
- `keys`: One or an array of keys that are used in [`useState`](/docs/4.x/api/composables/use-state) to delete their cached state. If no keys are provided, **all state** will be invalidated.
|
|
@@ -45,11 +45,11 @@ Use `createError` to trigger error handling in server API routes.
|
|
|
45
45
|
export default eventHandler(() => {
|
|
46
46
|
throw createError({
|
|
47
47
|
statusCode: 404,
|
|
48
|
-
statusMessage: 'Page Not Found'
|
|
48
|
+
statusMessage: 'Page Not Found',
|
|
49
49
|
})
|
|
50
50
|
})
|
|
51
51
|
```
|
|
52
52
|
|
|
53
53
|
In API routes, using `createError` by passing an object with a short `statusMessage` is recommended because it can be accessed on the client side. Otherwise, a `message` passed to `createError` on an API route will not propagate to the client. Alternatively, you can use the `data` property to pass data back to the client. In any case, always consider avoiding to put dynamic user input to the message to avoid potential security issues.
|
|
54
54
|
|
|
55
|
-
:read-more{to="/docs/getting-started/error-handling"}
|
|
55
|
+
:read-more{to="/docs/4.x/getting-started/error-handling"}
|
|
@@ -20,13 +20,13 @@ Hydrates the component when it becomes visible in the viewport.
|
|
|
20
20
|
<script setup lang="ts">
|
|
21
21
|
const LazyHydrationMyComponent = defineLazyHydrationComponent(
|
|
22
22
|
'visible',
|
|
23
|
-
() => import('./components/MyComponent.vue')
|
|
23
|
+
() => import('./components/MyComponent.vue'),
|
|
24
24
|
)
|
|
25
25
|
</script>
|
|
26
26
|
|
|
27
27
|
<template>
|
|
28
28
|
<div>
|
|
29
|
-
<!--
|
|
29
|
+
<!--
|
|
30
30
|
Hydration will be triggered when
|
|
31
31
|
the element(s) is 100px away from entering the viewport.
|
|
32
32
|
-->
|
|
@@ -53,7 +53,7 @@ Hydrates the component when the browser is idle. This is suitable if you need th
|
|
|
53
53
|
<script setup lang="ts">
|
|
54
54
|
const LazyHydrationMyComponent = defineLazyHydrationComponent(
|
|
55
55
|
'idle',
|
|
56
|
-
() => import('./components/MyComponent.vue')
|
|
56
|
+
() => import('./components/MyComponent.vue'),
|
|
57
57
|
)
|
|
58
58
|
</script>
|
|
59
59
|
|
|
@@ -81,7 +81,7 @@ Hydrates the component after a specified interaction (e.g., click, mouseover).
|
|
|
81
81
|
<script setup lang="ts">
|
|
82
82
|
const LazyHydrationMyComponent = defineLazyHydrationComponent(
|
|
83
83
|
'interaction',
|
|
84
|
-
() => import('./components/MyComponent.vue')
|
|
84
|
+
() => import('./components/MyComponent.vue'),
|
|
85
85
|
)
|
|
86
86
|
</script>
|
|
87
87
|
|
|
@@ -110,7 +110,7 @@ Hydrates the component when the window matches a media query.
|
|
|
110
110
|
<script setup lang="ts">
|
|
111
111
|
const LazyHydrationMyComponent = defineLazyHydrationComponent(
|
|
112
112
|
'mediaQuery',
|
|
113
|
-
() => import('./components/MyComponent.vue')
|
|
113
|
+
() => import('./components/MyComponent.vue'),
|
|
114
114
|
)
|
|
115
115
|
</script>
|
|
116
116
|
|
|
@@ -136,8 +136,8 @@ Hydrates the component after a specified delay (in milliseconds).
|
|
|
136
136
|
```vue
|
|
137
137
|
<script setup lang="ts">
|
|
138
138
|
const LazyHydrationMyComponent = defineLazyHydrationComponent(
|
|
139
|
-
'time',
|
|
140
|
-
() => import('./components/MyComponent.vue')
|
|
139
|
+
'time',
|
|
140
|
+
() => import('./components/MyComponent.vue'),
|
|
141
141
|
)
|
|
142
142
|
</script>
|
|
143
143
|
|
|
@@ -159,12 +159,12 @@ Hydrates the component based on a boolean condition.
|
|
|
159
159
|
<script setup lang="ts">
|
|
160
160
|
const LazyHydrationMyComponent = defineLazyHydrationComponent(
|
|
161
161
|
'if',
|
|
162
|
-
() => import('./components/MyComponent.vue')
|
|
162
|
+
() => import('./components/MyComponent.vue'),
|
|
163
163
|
)
|
|
164
164
|
|
|
165
165
|
const isReady = ref(false)
|
|
166
166
|
|
|
167
|
-
function myFunction() {
|
|
167
|
+
function myFunction () {
|
|
168
168
|
// Trigger custom hydration strategy...
|
|
169
169
|
isReady.value = true
|
|
170
170
|
}
|
|
@@ -188,7 +188,7 @@ Never hydrates the component.
|
|
|
188
188
|
<script setup lang="ts">
|
|
189
189
|
const LazyHydrationMyComponent = defineLazyHydrationComponent(
|
|
190
190
|
'never',
|
|
191
|
-
() => import('./components/MyComponent.vue')
|
|
191
|
+
() => import('./components/MyComponent.vue'),
|
|
192
192
|
)
|
|
193
193
|
</script>
|
|
194
194
|
|
|
@@ -208,11 +208,11 @@ All delayed hydration components emit a `@hydrated` event when they are hydrated
|
|
|
208
208
|
<script setup lang="ts">
|
|
209
209
|
const LazyHydrationMyComponent = defineLazyHydrationComponent(
|
|
210
210
|
'visible',
|
|
211
|
-
() => import('./components/MyComponent.vue')
|
|
211
|
+
() => import('./components/MyComponent.vue'),
|
|
212
212
|
)
|
|
213
213
|
|
|
214
|
-
function onHydrate() {
|
|
215
|
-
console.log(
|
|
214
|
+
function onHydrate () {
|
|
215
|
+
console.log('Component has been hydrated!')
|
|
216
216
|
}
|
|
217
217
|
</script>
|
|
218
218
|
|
|
@@ -25,11 +25,11 @@ If you choose not to use `setup()` in your app, you can use the `asyncData()` me
|
|
|
25
25
|
```vue [app/pages/index.vue]
|
|
26
26
|
<script lang="ts">
|
|
27
27
|
export default defineNuxtComponent({
|
|
28
|
-
|
|
28
|
+
asyncData () {
|
|
29
29
|
return {
|
|
30
30
|
data: {
|
|
31
|
-
greetings: 'hello world!'
|
|
32
|
-
}
|
|
31
|
+
greetings: 'hello world!',
|
|
32
|
+
},
|
|
33
33
|
}
|
|
34
34
|
},
|
|
35
35
|
})
|
|
@@ -43,9 +43,9 @@ If you choose not to use `setup()` in your app, you can use the `head()` method
|
|
|
43
43
|
```vue [app/pages/index.vue]
|
|
44
44
|
<script lang="ts">
|
|
45
45
|
export default defineNuxtComponent({
|
|
46
|
-
head(nuxtApp) {
|
|
46
|
+
head (nuxtApp) {
|
|
47
47
|
return {
|
|
48
|
-
title: 'My site'
|
|
48
|
+
title: 'My site',
|
|
49
49
|
}
|
|
50
50
|
},
|
|
51
51
|
})
|
|
@@ -16,14 +16,14 @@ export default defineNuxtPlugin((nuxtApp) => {
|
|
|
16
16
|
})
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
:read-more{to="/docs/guide/directory-structure/app/plugins#creating-plugins"}
|
|
19
|
+
:read-more{to="/docs/4.x/guide/directory-structure/app/plugins#creating-plugins"}
|
|
20
20
|
|
|
21
21
|
## Type
|
|
22
22
|
|
|
23
|
-
```ts
|
|
24
|
-
defineNuxtPlugin<T extends Record<string, unknown>>(plugin: Plugin<T> | ObjectPlugin<T>): Plugin<T> & ObjectPlugin<T>
|
|
23
|
+
```ts [Signature]
|
|
24
|
+
export function defineNuxtPlugin<T extends Record<string, unknown>> (plugin: Plugin<T> | ObjectPlugin<T>): Plugin<T> & ObjectPlugin<T>
|
|
25
25
|
|
|
26
|
-
type Plugin<T> = (nuxt:
|
|
26
|
+
type Plugin<T> = (nuxt: NuxtApp) => Promise<void> | Promise<{ provide?: T }> | void | { provide?: T }
|
|
27
27
|
|
|
28
28
|
interface ObjectPlugin<T> {
|
|
29
29
|
name?: string
|
|
@@ -32,7 +32,7 @@ interface ObjectPlugin<T> {
|
|
|
32
32
|
order?: number
|
|
33
33
|
parallel?: boolean
|
|
34
34
|
setup?: Plugin<T>
|
|
35
|
-
hooks?: Partial<
|
|
35
|
+
hooks?: Partial<RuntimeNuxtHooks>
|
|
36
36
|
env?: {
|
|
37
37
|
islands?: boolean
|
|
38
38
|
}
|
|
@@ -42,7 +42,7 @@ interface ObjectPlugin<T> {
|
|
|
42
42
|
## Parameters
|
|
43
43
|
|
|
44
44
|
**plugin**: A plugin can be defined in two ways:
|
|
45
|
-
1. **Function Plugin**: A function that receives the [`NuxtApp`](/docs/guide/going-further/internals#the-nuxtapp-interface) instance and can return a promise with an potential object with a [`provide`](/docs/guide/directory-structure/plugins#providing-helpers) property if you want to provide a helper on [`NuxtApp`](/docs/guide/going-further/internals#the-nuxtapp-interface) instance.
|
|
45
|
+
1. **Function Plugin**: A function that receives the [`NuxtApp`](/docs/4.x/guide/going-further/internals#the-nuxtapp-interface) instance and can return a promise with an potential object with a [`provide`](/docs/4.x/guide/directory-structure/plugins#providing-helpers) property if you want to provide a helper on [`NuxtApp`](/docs/4.x/guide/going-further/internals#the-nuxtapp-interface) instance.
|
|
46
46
|
2. **Object Plugin**: An object that can include various properties to configure the plugin's behavior, such as `name`, `enforce`, `dependsOn`, `order`, `parallel`, `setup`, `hooks`, and `env`.
|
|
47
47
|
|
|
48
48
|
| Property | Type | Required | Description |
|
|
@@ -69,8 +69,8 @@ export default defineNuxtPlugin((nuxtApp) => {
|
|
|
69
69
|
// Add a global method
|
|
70
70
|
return {
|
|
71
71
|
provide: {
|
|
72
|
-
hello: (name: string) => `Hello ${name}
|
|
73
|
-
}
|
|
72
|
+
hello: (name: string) => `Hello ${name}!`,
|
|
73
|
+
},
|
|
74
74
|
}
|
|
75
75
|
})
|
|
76
76
|
```
|
|
@@ -86,17 +86,17 @@ export default defineNuxtPlugin({
|
|
|
86
86
|
async setup (nuxtApp) {
|
|
87
87
|
// Plugin setup logic
|
|
88
88
|
const data = await $fetch('/api/config')
|
|
89
|
-
|
|
89
|
+
|
|
90
90
|
return {
|
|
91
91
|
provide: {
|
|
92
|
-
config: data
|
|
93
|
-
}
|
|
92
|
+
config: data,
|
|
93
|
+
},
|
|
94
94
|
}
|
|
95
95
|
},
|
|
96
96
|
hooks: {
|
|
97
|
-
'app:created'() {
|
|
97
|
+
'app:created' () {
|
|
98
98
|
console.log('App created!')
|
|
99
|
-
}
|
|
99
|
+
},
|
|
100
100
|
},
|
|
101
101
|
})
|
|
102
102
|
```
|
|
@@ -8,12 +8,12 @@ links:
|
|
|
8
8
|
size: xs
|
|
9
9
|
---
|
|
10
10
|
|
|
11
|
-
Route middleware are stored in the [`app/middleware/`](/docs/guide/directory-structure/app/middleware) of your Nuxt application (unless [set otherwise](/docs/api/nuxt-config#middleware)).
|
|
11
|
+
Route middleware are stored in the [`app/middleware/`](/docs/4.x/guide/directory-structure/app/middleware) of your Nuxt application (unless [set otherwise](/docs/4.x/api/nuxt-config#middleware)).
|
|
12
12
|
|
|
13
13
|
## Type
|
|
14
14
|
|
|
15
|
-
```ts
|
|
16
|
-
defineNuxtRouteMiddleware(middleware: RouteMiddleware)
|
|
15
|
+
```ts [Signature]
|
|
16
|
+
export function defineNuxtRouteMiddleware (middleware: RouteMiddleware): RouteMiddleware
|
|
17
17
|
|
|
18
18
|
interface RouteMiddleware {
|
|
19
19
|
(to: RouteLocationNormalized, from: RouteLocationNormalized): ReturnType<NavigationGuard>
|
|
@@ -48,7 +48,7 @@ The above route middleware will redirect a user to the custom error page defined
|
|
|
48
48
|
|
|
49
49
|
### Redirection
|
|
50
50
|
|
|
51
|
-
Use [`useState`](/docs/api/composables/use-state) in combination with `navigateTo` helper function inside the route middleware to redirect users to different routes based on their authentication status:
|
|
51
|
+
Use [`useState`](/docs/4.x/api/composables/use-state) in combination with `navigateTo` helper function inside the route middleware to redirect users to different routes based on their authentication status:
|
|
52
52
|
|
|
53
53
|
```ts [app/middleware/auth.ts]
|
|
54
54
|
export default defineNuxtRouteMiddleware((to, from) => {
|
|
@@ -64,4 +64,4 @@ export default defineNuxtRouteMiddleware((to, from) => {
|
|
|
64
64
|
})
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
Both [navigateTo](/docs/api/utils/navigate-to) and [abortNavigation](/docs/api/utils/abort-navigation) are globally available helper functions that you can use inside `defineNuxtRouteMiddleware`.
|
|
67
|
+
Both [navigateTo](/docs/4.x/api/utils/navigate-to) and [abortNavigation](/docs/4.x/api/utils/abort-navigation) are globally available helper functions that you can use inside `defineNuxtRouteMiddleware`.
|