插件
Nuxt Kit 提供了一系列工具，帮助您创建和使用插件。您可以使用这些函数将插件或插件模板添加到您的模块中。
插件是独立的代码，通常为 Vue 添加应用程序级别的功能。在 Nuxt 中，插件会自动从 plugins 目录导入。然而，如果您需要在模块中包含一个插件，Nuxt Kit 提供了 addPlugin 和 addPluginTemplate 方法。这些实用程序允许您自定义插件的配置，以更好地满足您的需求。
addPlugin
在插件的数组中注册一个 Nuxt 插件。
类型
function addPlugin (plugin: NuxtPlugin | string, options: AddPluginOptions): NuxtPlugin
interface NuxtPlugin {
src: string
mode?: 'all' | 'server' | 'client'
order?: number
}
interface AddPluginOptions { append?: boolean }
参数
plugin
类型: NuxtPlugin | string
必填: true
一个插件对象或指向插件的路径字符串。如果提供一个字符串，它将被转换为具有 src 设置为字符串值的插件对象。如果提供一个插件对象，它必须具有以下属性:
src(必填)
类型:string
插件的路径。mode(可选)
类型:'all' | 'server' | 'client'
默认:'all'
如果设置为'all'，插件将在客户端和服务器包中都包含。如果设置为'server'，插件将只包含在服务器包中。如果设置为'client'，插件将只包含在客户端包中。您也可以在使用src选项时使用.client和.server修饰符来在客户端或服务器端使用插件。order(可选)
类型:number
默认:0
插件的顺序。这允许更精细地控制插件顺序，只应该由高级用户使用。较低的数字先运行，用户的插件默认是0。建议将order设置为介于-20和20之间的数字，为pre插件（在 Nuxt 插件之前运行的插件）和post插件（在 Nuxt 插件之后运行的插件）之间提供更多的控制。
除非你知道自己在做什么，否则不要使用
order。对于大多数插件，默认的 order 为 0 就足够了。要将在插件数组末尾追加插件，请使用 append 选项。options
类型: AddPluginOptions
默认: {}
传递给插件的选项。如果 append 设置为 true，插件将追加到插件数组末尾，而不是插入到前面。
例子
import { createResolver, defineNuxtModule, addPlugin } from '@nuxt/kit'
export default defineNuxtModule({
setup() {
const resolver = createResolver(import.meta.url)
addPlugin({
src: resolver.resolve('runtime/plugin.js'),
mode: 'client'
})
}
})
addPluginTemplate
添加一个模板并注册为一个nuxt插件。这对于需要在构建时生成代码的插件非常有用。
类型
function addPluginTemplate (pluginOptions: NuxtPluginTemplate, options: AddPluginOptions): NuxtPlugin
interface NuxtPluginTemplate<Options = Record<string, any>> {
src?: string,
filename?: string,
dst?: string,
mode?: 'all' | 'server' | 'client',
options?: Options,
getContents?: (data: Options) => string | Promise<string>,
write?: boolean,
order?: number
}
interface AddPluginOptions { append?: boolean }
interface NuxtPlugin {
src: string
mode?: 'all' | 'server' | 'client'
order?: number
}
参数
pluginOptions
类型: NuxtPluginTemplate
必填: true
一个插件模板对象，具有以下属性:
src(可选)
类型:string
模板的路径。如果src没有提供，那么必须提供getContents。filename(可选)
类型:string
模板的文件名。如果filename没有提供，它将从src路径生成。在这种情况下，src选项是必须的。dst(可选)
类型:string
目标文件的路径。如果dst没有提供，它将从filename路径和 Nuxt 的buildDir选项生成。mode(可选)
类型:'all' | 'server' | 'client'
默认:'all'
如果设置为'all'，插件将在客户端和服务器包中都包含。如果设置为'server'，插件将只包含在服务器包中。如果设置为'client'，插件将只包含在客户端包中。您也可以在使用src选项时使用.client和.server修饰符来在客户端或服务器端使用插件。options(可选)
类型:Options
传递给模板的选项。getContents(可选)
类型:(data: Options) => string | Promise<string>
一个函数，当它被调用时，会使用options对象。它应该返回一个字符串或一个以字符串为解的承诺。如果提供了src，这个函数将被忽略。write(可选)
类型:boolean
如果设置为true，模板将被写入目标文件。否则，模板将只在使用虚拟文件系统时使用。order(可选)
类型:number
默认:0
插件的顺序。这允许更精细地控制插件顺序，只应该由高级用户使用。较低的数字先运行，用户的插件默认是0。建议将order设置为介于-20和20之间的数字，为pre插件（在 Nuxt 插件之前运行的插件）和post插件（在 Nuxt 插件之后运行的插件）之间提供更多的控制。
除非你知道自己在做什么，否则不要使用
order。对于大多数插件，默认的 order 为 0 就足够了。要将在插件数组末尾追加插件，请使用 append 选项。options
类型: AddPluginOptions
默认: {}
传递给插件的选项。如果 append 设置为 true，插件将追加到插件数组末尾，而不是插入到前面。
例子
// https://github.com/vuejs/vuefire
import { createResolver, defineNuxtModule, addPluginTemplate } from '@nuxt/kit'
export default defineNuxtModule({
setup() {
const resolver = createResolver(import.meta.url)
addPluginTemplate({
src: resolve(templatesDir, 'plugin.ejs'),
filename: 'plugin.mjs',
options: {
...options,
ssr: nuxt.options.ssr,
},
})
}
})