Type definition of useError() differs between document and actual

[uyamazak]

Environment

---

• Operating System: Darwin
• Node Version: v18.7.0
• Nuxt Version: 3.0.0-rc.11
• Nitro Version: 0.5.4
• Package Manager: yarn@1.22.19
• Builder: vite
• User Config: buildModules, meta, ssr, publicRuntimeConfig, css, tailwindcss
• Runtime Modules: -
• Build Modules: @nuxtjs/tailwindcss@5.3.3

---

Reproduction

document
https://v3.nuxtjs.org/getting-started/error-handling#useerror
https://github.com/nuxt/framework/blob/main/docs/content/1.getting-started/8.error-handling.md#useerror

type definition code
https://github.com/nuxt/framework/blob/main/packages/nuxt/src/app/nuxt.ts#L82

Describe the bug

Type of useError() return value is Ref<any> in document,

https://v3.nuxtjs.org/getting-started/error-handling#useerror

function useError (): Ref<any>

but actual below.

https://github.com/nuxt/framework/blob/main/packages/nuxt/src/app/nuxt.ts#L82

Ref<Error | {
    url: string;
    statusCode: string;
    statusMessage: string;
    message: string;
    description: string;
    data?: any;
}>

Additional context

Probably because of the following changes

https://github.com/nuxt/framework/pull/6389/files

I will create a PR if the following change is acceptable.
nuxt/framework@main...uyamazak:framework:fix_userrror_type_in_doc

Logs

No response

[danielroe]

It looks good to me - thank you ❤️