shared

使用 shared/ 目录在 Vue 应用和 Nitro 服务器之间共享功能。

shared/ 目录允许您共享可以在 Vue 应用和 Nitro 服务器中使用的代码。

shared/ 目录在 Nuxt v3.14+ 中可用。
shared/ 目录中的代码不能导入任何 Vue 或 Nitro 代码。

使用方法

方法 1: 使用命名导出

shared/utils/capitalize.ts
export const 
capitalize
= (
input
: string) => {
return
input
[0] ?
input
[0].
toUpperCase
() +
input
.
slice
(1) : ''
}

方法 2: 使用默认导出

shared/utils/capitalize.ts
export default function 
capitalize
(
input
: string) {
return
input
[0] ?
input
[0].
toUpperCase
() +
input
.
slice
(1) : ''
}

使用方法: 您现在可以在 Vue 应用和 server/ 目录中的 .js.ts.vue 文件中使用自动导入的工具函数。

如果您已在 nuxt.config.ts设置 compatibilityVersion: 4,则可以在 app/ 目录中使用自动导入的函数。这是 Nuxt 为版本 4 准备的渐进式兼容性功能的一部分。

app.vue
<script setup lang="ts">
const hello = capitalize('hello')
</script>

<template>
  <div>
    {{ hello }}
  </div>
</template>
server/api/hello.get.ts
export default defineEventHandler((event) => {
  return {
    hello: capitalize('hello')
  }
})

自动导入

shared/utils/shared/types/ 目录中的文件会被自动导入。这些目录的子目录中的文件不会被自动导入。

shared/utilsshared/types 的自动导入工作原理和扫描方式与 composables/utils/ 目录相同。
Read more in Docs > Guide > Directory Structure > Composables#how Files Are Scanned.
目录结构
-| shared/
---| capitalize.ts        # 不自动导入
---| formatters
-----| lower.ts           # 不自动导入
---| utils/
-----| lower.ts           # 自动导入
-----| formatters
-------| upper.ts         # 不自动导入
---| types/
-----| bar.d.ts           # 自动导入

您在 shared/ 文件夹中创建的任何其他文件必须使用 #shared 别名手动导入(Nuxt 自动配置):

// 对于直接在 shared 目录中的文件
import capitalize from '#shared/capitalize'

// 对于嵌套目录中的文件
import lower from '#shared/formatters/lower'

// 对于嵌套在工具中的文件
import upper from '#shared/utils/formatters/upper'

该别名确保无论导入文件的位置如何,您的应用程序中的导入都是一致的。

Read more in Docs > Guide > Concepts > Auto Imports.