Skip to content

compression(options?)

ts
compression({
	algorithms: ["gzip", "brotli"],
	threshold: 10 * 1024,
	minRatio: 0.95,
});
选项默认值说明
algorithmsgzip + Brotli单个算法或算法数组
threshold1024最小原始字节数
minRatio0.95输出压缩文件的最大体积比
filter常见文本/wasm正则或函数过滤器
fileName.gz / .br自定义安全且不冲突的相对文件名
gzipOptions / brotliOptionsNode 默认值传给 node:zlib 的选项

生成文件后还需要服务器按 Accept-Encoding 提供对应资源。

compression 压缩

为构建产物生成 .gz / .br 预压缩文件,适合 Nginx、Caddy 与对象存储直接提供静态压缩资源。

签名

ts
export function compression(options: CompressionPluginOptions = {}): Plugin;

示例

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

const plugin = compression({ algorithms: ["gzip", "brotli"], threshold: 1024 });

export default { plugins: [plugin] };

输入

输入值输入值类型必填/默认值输入值说明
optionsCompressionPluginOptions否,默认 {}压缩算法、阈值、收益率、过滤器和编码器选项。

返回

返回值返回值类型返回值说明
pluginPlugin可直接加入 Vite plugins 的预压缩插件。