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 (input: string) {
  return input[0] ? input[0].toUpperCase() + input.slice(1) : ''
}

现在你可以在 Nuxt 应用和 server/ 目录中使用这些自动导入 的工具了。

app/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/ 目录下的文件会被自动导入。位于这些目录子目录中的文件不会被自动导入,除非你将这些子目录添加到 imports.dirsnitro.imports.dirs

shared/utilsshared/types 的自动导入和扫描方式与 app/composables/app/utils/ 目录的行为相同。
Docs > 4 X > Directory Structure > App > Composables#how Files Are Scanned 中查看详情
Directory Structure
-| shared/
---| capitalize.ts        # 不会自动导入
---| formatters
-----| lower.ts           # 不会自动导入
---| utils/
-----| lower.ts           # 自动导入
-----| formatters
-------| upper.ts         # 不会自动导入
---| types/
-----| bar.ts             # 自动导入

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

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

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

// 对于 utils 内某文件夹中的文件
import upper from '#shared/utils/formatters/upper'

此别名确保无论导入文件位置在哪里,导入路径都保持一致。

Docs > 4 X > Guide > Concepts > Auto Imports 中查看详情