Interface: UnzlibOptions\

May 16, 2026 · View on GitHub

Interface: UnzlibOptions<TArrayBuffer>

Options for decompressing Zlib data

TArrayBuffer extends ArrayBufferLike = ArrayBufferLike

optional dictionary?: Uint8Array

The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

Supplying the wrong dictionary during decompression usually yields corrupt output or causes an invalid distance error.

optional out?: Uint8Array<TArrayBuffer>

The buffer into which to write the decompressed data. Saves memory if you know the decompressed size in advance.

Note that if the decompression result is larger than the size of this buffer, it will be truncated to fit.