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 > Directory Structure > App > Composables#how Files Are Scanned 中阅读更多。
目录结构
|-| 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'

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

https://nuxt.com/docs/guide/concepts/auto-imports 中阅读更多。