zlib: add dictionary support to zstdCompress and zstdDecompress

Adds optional dictionary support to zlib’s zstdCompress and
zstdDecompress APIs. This enables better compression ratios when the
dictionary matches expected input structure or content patterns.

The implementation allows passing a `dictionary` buffer through the
options object. Support was added to both streaming and convenience
methods. Tests and documentation were also updated to reflect this new
capability.

Fixes: https://github.com/nodejs/node/issues/59105
PR-URL: https://github.com/nodejs/node/pull/59240
Reviewed-By: Anna Henningsen <anna@addaleax.net>
This commit is contained in:
lluisemper 2025-08-04 18:13:57 +02:00 committed by GitHub
parent f7c2a7ed4a
commit b8e643259e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 79 additions and 7 deletions

View file

@ -0,0 +1,26 @@
'use strict';
const common = require('../common');
const assert = require('assert');
const zlib = require('zlib');
const dictionary = Buffer.from(
`Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.`
);
const input = Buffer.from(
`Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.`
);
zlib.zstdCompress(input, { dictionary }, common.mustSucceed((compressed) => {
assert(compressed.length < input.length);
zlib.zstdDecompress(compressed, { dictionary }, common.mustSucceed((decompressed) => {
assert.strictEqual(decompressed.toString(), input.toString());
}));
}));