@nuxt/docs-nightly 4.3.0-29434410.5b16a51f → 4.3.0-29435873.41a564d2

package/1.getting-started/07.routing.md

@@ -135,7 +135,7 @@ definePageMeta({
 
 Nuxt offers route validation via the `validate` property in [`definePageMeta()`](/docs/4.x/api/utils/define-page-meta) in each page you wish to validate.
 
-The `validate` property accepts the `route` as an argument. You can return a boolean value to determine whether or not this is a valid route to be rendered with this page. If you return `false`, this will cause a 404 error. You can also directly return an object with `statusCode`/`statusMessage` to customize the error returned.
+The `validate` property accepts the `route` as an argument. You can return a boolean value to determine whether or not this is a valid route to be rendered with this page. If you return `false`, this will cause a 404 error. You can also directly return an object with `status`/`statusText` to customize the error returned.
 
 If you have a more complex use case, then you can use anonymous route middleware instead.
 

package/1.getting-started/12.error-handling.md

@@ -99,7 +99,7 @@ const handleError = () => clearError({ redirect: '/' })
 
 <template>
   <div>
-    <h2>{{ error?.statusCode }}</h2>
+    <h2>{{ error?.status }}</h2>
     <button @click="handleError">
       Clear errors
     </button>
@@ -140,7 +140,7 @@ If you are running on Node 16 and you set any cookies when rendering your error
 ### `useError`
 
 ```ts [TS Signature]
-function useError (): Ref<Error | { url, statusCode, statusMessage, message, description, data }>
+function useError (): Ref<Error | { url, status, statusText, message, description, data }>
 ```
 
 This function will return the global Nuxt error that is being handled.
@@ -152,7 +152,7 @@ Read more about `useError` composable.
 ### `createError`
 
 ```ts [TS Signature]
-function createError (err: string | { cause, data, message, name, stack, statusCode, statusMessage, fatal }): Error
+function createError (err: string | { cause, data, message, name, stack, status, statusText, fatal }): Error
 ```
 
 Create an error object with additional metadata. You can pass a string to be set as the error `message` or an object containing error properties. It is usable in both the Vue and Server portions of your app, and is meant to be thrown.
@@ -168,8 +168,8 @@ const { data } = await useFetch(`/api/movies/${route.params.slug}`)
 
 if (!data.value) {
   throw createError({
-    statusCode: 404,
-    statusMessage: 'Page Not Found',
+    status: 404,
+    statusText: 'Page Not Found',
   })
 }
 </script>
@@ -182,7 +182,7 @@ Read more about `createError` util.
 ### `showError`
 
 ```ts [TS Signature]
-function showError (err: string | Error | { statusCode, statusMessage }): Error
+function showError (err: string | Error | { status, statusText }): Error
 ```
 
 You can call this function at any point on client-side, or (on server side) directly within middleware, plugins or `setup()` functions. It will trigger a full-screen error page which you can clear with [`clearError`](/docs/4.x/getting-started/error-handling#clearerror).

package/2.directory-structure/1.app/3.error.md

@@ -16,7 +16,7 @@ const props = defineProps<{ error: NuxtError }>()
 
 <template>
   <div>
-    <h1>{{ error.statusCode }}</h1>
+    <h1>{{ error.status }}</h1>
     <NuxtLink to="/">Go back home</NuxtLink>
   </div>
 </template>
@@ -31,12 +31,16 @@ The error page has a single prop - `error` which contains an error for you to ha
 The `error` object provides the following fields:
 ```ts
 interface NuxtError {
-  statusCode: number
+  status: number
   fatal: boolean
   unhandled: boolean
-  statusMessage?: string
+  statusText?: string
   data?: unknown
   cause?: unknown
+  // legacy/deprecated equivalent of `status`
+  statusCode: number
+  // legacy/deprecated equivalent of `statusText`
+  statusMessage?: string
 }
 ```
 
@@ -44,8 +48,8 @@ If you have an error with custom fields they will be lost; you should assign the
 
 ```ts
 throw createError({
-  statusCode: 404,
-  statusMessage: 'Page Not Found',
+  status: 404,
+  statusText: 'Page Not Found',
   data: {
     myCustomField: true,
   },

package/2.directory-structure/1.server.md

@@ -295,8 +295,8 @@ export default defineEventHandler((event) => {
 
   if (!Number.isInteger(id)) {
     throw createError({
-      statusCode: 400,
-      statusMessage: 'ID should be an integer',
+      status: 400,
+      statusText: 'ID should be an integer',
     })
   }
   return 'All good'

package/3.guide/1.concepts/2.nuxt-lifecycle.md

@@ -54,7 +54,7 @@ After this step, Nuxt calls the [`app:created`](/docs/4.x/api/advanced/hooks#app
 After initializing plugins and before executing middleware, Nuxt calls the `validate` method if it is defined in the `definePageMeta` function. The `validate` method, which can be synchronous or asynchronous, is often used to validate dynamic route parameters.
 
 - The `validate` function should return `true` if the parameters are valid.
-- If validation fails, it should return `false` or an object containing a `statusCode` and/or `statusMessage` to terminate the request.
+- If validation fails, it should return `false` or an object containing a `status` and/or `statusText` to terminate the request.
 
 For more information, see the [Route Validation documentation](/docs/4.x/getting-started/routing#route-validation).
 

package/3.guide/5.recipes/3.custom-usefetch.md

@@ -98,7 +98,7 @@ import type { UseFetchOptions } from 'nuxt/app'
 
 interface CustomError {
   message: string
-  statusCode: number
+  status: number
 }
 
 export function useAPI<T> (

package/3.guide/5.recipes/4.sessions-and-authentication.md

@@ -65,7 +65,7 @@ export default defineEventHandler(async (event) => {
     return {}
   }
   throw createError({
-    statusCode: 401,
+    status: 401,
     message: 'Bad credentials',
   })
 })

package/4.api/2.composables/use-error.md

@@ -22,8 +22,8 @@ You can use this composable in your components, pages, or plugins to access or r
 
 ```ts
 interface NuxtError<DataT = unknown> {
-  statusCode: number
-  statusMessage: string
+  status: number
+  statusText: string
   message: string
   data?: DataT
   error?: true

package/4.api/3.utils/create-error.md

@@ -12,9 +12,9 @@ You can use this function to create an error object with additional metadata. It
 
 ## Parameters
 
-- `err`: `string | { cause, data, message, name, stack, statusCode, statusMessage, fatal }`
+- `err`: `string | { cause, data, message, name, stack, status, statusText, fatal }`
 
-You can pass either a string or an object to the `createError` function. If you pass a string, it will be used as the error `message`, and the `statusCode` will default to `500`. If you pass an object, you can set multiple properties of the error, such as `statusCode`, `message`, and other error properties.
+You can pass either a string or an object to the `createError` function. If you pass a string, it will be used as the error `message`, and the `status` will default to `500`. If you pass an object, you can set multiple properties of the error, such as `status`, `message`, and other error properties.
 
 ## In Vue App
 
@@ -30,7 +30,7 @@ If you throw an error created with `createError`:
 const route = useRoute()
 const { data } = await useFetch(`/api/movies/${route.params.slug}`)
 if (!data.value) {
-  throw createError({ statusCode: 404, statusMessage: 'Page Not Found' })
+  throw createError({ status: 404, statusText: 'Page Not Found' })
 }
 </script>
 ```
@@ -44,12 +44,12 @@ Use `createError` to trigger error handling in server API routes.
 ```ts [server/api/error.ts]
 export default eventHandler(() => {
   throw createError({
-    statusCode: 404,
-    statusMessage: 'Page Not Found',
+    status: 404,
+    statusText: 'Page Not Found',
   })
 })
 ```
 
-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.
+In API routes, using `createError` by passing an object with a short `statusText` 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.
 
 :read-more{to="/docs/4.x/getting-started/error-handling"}

package/4.api/3.utils/define-nuxt-route-middleware.md

@@ -39,7 +39,7 @@ You can use route middleware to throw errors and show helpful error messages:
 ```ts [app/middleware/error.ts]
 export default defineNuxtRouteMiddleware((to) => {
   if (to.params.id === '1') {
-    throw createError({ statusCode: 404, statusMessage: 'Page Not Found' })
+    throw createError({ status: 404, statusText: 'Page Not Found' })
   }
 })
 ```

package/4.api/3.utils/define-page-meta.md

@@ -130,7 +130,7 @@ interface PageMeta {
 
   - **Type**: `(route: RouteLocationNormalized) => boolean | Promise<boolean> | Partial<NuxtError> | Promise<Partial<NuxtError>>`
 
-    Validate whether a given route can validly be rendered with this page. Return true if it is valid, or false if not. If another match can't be found, this will mean a 404. You can also directly return an object with `statusCode`/`statusMessage` to respond immediately with an error (other matches will not be checked).
+    Validate whether a given route can validly be rendered with this page. Return true if it is valid, or false if not. If another match can't be found, this will mean a 404. You can also directly return an object with `status`/`statusText` to respond immediately with an error (other matches will not be checked).
 
   **`scrollToTop`**
 

package/4.api/3.utils/set-response-status.md

@@ -1,6 +1,6 @@
 ---
 title: 'setResponseStatus'
-description: setResponseStatus sets the statusCode (and optionally the statusMessage) of the response.
+description: setResponseStatus sets the status (and optionally the statusText) of the response.
 links:
   - label: Source
     icon: i-simple-icons-github
@@ -10,7 +10,7 @@ links:
 
 Nuxt provides composables and utilities for first-class server-side-rendering support.
 
-`setResponseStatus` sets the statusCode (and optionally the statusMessage) of the response.
+`setResponseStatus` sets the status (and optionally the statusText) of the response.
 
 ::important
 `setResponseStatus` can only be called in the [Nuxt context](/docs/4.x/guide/going-further/nuxt-app#the-nuxt-context).

package/4.api/3.utils/show-error.md

@@ -12,13 +12,13 @@ Within the [Nuxt context](/docs/4.x/guide/going-further/nuxt-app#the-nuxt-contex
 
 **Parameters:**
 
-- `error`: `string | Error | Partial<{ cause, data, message, name, stack, statusCode, statusMessage }>`
+- `error`: `string | Error | Partial<{ cause, data, message, name, stack, status, statusText }>`
 
 ```ts
 showError('😱 Oh no, an error has been thrown.')
 showError({
-  statusCode: 404,
-  statusMessage: 'Page Not Found',
+  status: 404,
+  statusText: 'Page Not Found',
 })
 ```
 

package/7.migration/7.component-options.md

@@ -124,7 +124,7 @@ Similar to `key`, specify it within the [`definePageMeta`](/docs/4.x/api/utils/d
 
 ## `validate`
 
-The validate hook in Nuxt 3 only accepts a single argument, the `route`. Just as in Nuxt 2, you can return a boolean value. If you return false and another match can't be found, this will mean a 404. You can also directly return an object with `statusCode`/`statusMessage` to respond immediately with an error (other matches will not be checked).
+The validate hook in Nuxt 3 only accepts a single argument, the `route`. Just as in Nuxt 2, you can return a boolean value. If you return false and another match can't be found, this will mean a 404. You can also directly return an object with `status`/`statusText` to respond immediately with an error (other matches will not be checked).
 
 ```diff [app/pages/users/[id\\].vue]
 - <script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/docs-nightly",
-  "version": "4.3.0-29434410.5b16a51f",
+  "version": "4.3.0-29435873.41a564d2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nuxt/nuxt.git",