Skip to content

virtualModules(options)

ts
virtualModules({
	modules: {
		"virtual:feature-flags": "export default { beta: false };",
		"virtual:build-mode": ({ mode }) => `export default ${JSON.stringify(mode)};`,
	},
});

模块 ID 必须以 virtual: 开头,源码必须是合法 ESM。插件不会猜测导出类型,消费项目需要自行提供 declare module

virtualModules 虚拟模块

使用对象声明虚拟模块。

生成内容必须是合法 ESM 源码。消费项目应为每个公开模块 ID 提供相应的 declare module 声明,示例见 API 文档。

签名

ts
export function virtualModules(options: VirtualModulesPluginOptions): Plugin;

示例

ts
import { virtualModules } from "fast-vite-plugins";

const plugin = virtualModules({ modules: { "virtual:app-config": 'export default { name: "Fast" }' } });

export default { plugins: [plugin] };

输入

输入值输入值类型必填/默认值输入值说明
optionsVirtualModulesPluginOptions公开虚拟模块 ID 与静态或动态源码的映射。

返回

返回值返回值类型返回值说明
pluginPlugin可直接加入 Vite plugins 的虚拟模块插件。