Compression

Compression runs on the serialized string, after JSON/SuperJSON/msgpackr and before optional encryption.

import Keyv from "keyv";
import KeyvGzip from "@keyv/compress-gzip";

const keyv = new Keyv({ compression: new KeyvGzip() });

Table of Contents

• Official adapters
• Custom adapter

Official adapters

Pick gzip for portability, brotli for smaller payloads at higher CPU, lz4 when you want faster (de)compress.

Custom adapter

interface KeyvCompressionAdapter {
	compress(value: string): Promise<string>;
	decompress(value: string): Promise<string>;
}

Test with @keyv/test-suite:

import { compressionTestSuite } from "@keyv/test-suite";
import { it } from "vitest";
import KeyvGzip from "@keyv/compress-gzip";

compressionTestSuite(it, new KeyvGzip());

Serialization must stay enabled (the default). Disabling serialization bypasses compression regardless of the original value type.