Skip to content

compression(options?)

ts
compression({
	algorithms: ["gzip", "brotli"],
	threshold: 10 * 1024,
	minRatio: 0.95,
});
OptionDefaultDescription
algorithmsgzip + BrotliOne algorithm or an array
threshold1024Minimum original byte count
minRatio0.95Maximum compressed/original size ratio
filterCommon text/wasmRegExp or function filter
fileName.gz / .brCustom safe, nonconflicting relative filename
gzipOptions / brotliOptionsNode defaultsOptions passed to node:zlib

The server must still select generated resources according to Accept-Encoding.

compression Compress

Generates .gz/.br precompressed outputs for static serving by Nginx, Caddy, or object storage.

Signature

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

Example

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

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

export default { plugins: [plugin] };

Input

InputTypeRequired / defaultDescription
optionsCompressionPluginOptionsOptional; defaults to {}Algorithms, thresholds, size ratios, filters, and encoder options.

Returns

ValueTypeDescription
pluginPluginPrecompression plugin for Vite plugins.