shared/
目录允许您共享可以在 Vue 应用和 Nitro 服务器中使用的代码。
shared/
目录在 Nuxt v3.14+ 中可用。shared/
目录中的代码不能导入任何 Vue 或 Nitro 代码。默认情况下,Nuxt v3 中未启用自动导入,以防止对现有项目造成破坏性更改。要使用这些自动导入的工具和类型,您必须首先 在
nuxt.config.ts
中设置 future.compatibilityVersion: 4
。用法
方法 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.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.dirs
和 nitro.imports.dirs
中。
目录结构
-| shared/
---| capitalize.ts # 未自动导入
---| formatters
-----| lower.ts # 未自动导入
---| utils/
-----| lower.ts # 自动导入
-----| formatters
-------| upper.ts # 未自动导入
---| types/
-----| bar.d.ts # 自动导入
您在 shared/
文件夹中创建的任何其他文件必须使用 #共享
别名手动导入(由 Nuxt 自动配置):
// 对于共享目录中的文件
import capitalize from '#shared/capitalize'
// 对于嵌套目录中的文件
import lower from '#shared/formatters/lower'
// 对于 utils 中文件夹内的嵌套文件
import upper from '#shared/utils/formatters/upper'
此别名可确保您的应用程序中的导入一致,无论导入文件的位置如何。