shared
使用 shared/ 目录在 Vue 应用程序和 Nitro 服务器之间共享功能。
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 # Not auto-imported
---| formatters
-----| lower.ts # Not auto-imported
---| utils/
-----| lower.ts # Auto-imported
-----| formatters
-------| upper.ts # Not auto-imported
---| types/
-----| bar.d.ts # Auto-imported
您在 shared/
文件夹中创建的任何其他文件都必须使用 #shared
别名(由 Nuxt 自动配置)手动导入
// For files directly in the shared directory
import capitalize from '#shared/capitalize'
// For files in nested directories
import lower from '#shared/formatters/lower'
// For files nested in a folder within utils
import upper from '#shared/utils/formatters/upper'
此别名确保您的应用程序中导入的一致性,无论导入文件的位置如何。