interface

ArchiveOptions

interface ArchiveOptions

Options for creating an Archive instance.

By default, archives are not compressed. Use { compress: "gzip" } to enable compression.

// No compression (default)
new Bun.Archive(data);

// Enable gzip with default level (6)
new Bun.Archive(data, { compress: "gzip" });

// Specify compression level
new Bun.Archive(data, { compress: "gzip", level: 9 });
  • compress?: 'gzip'

    Compression algorithm to use. Only "gzip" is supported. If not specified, no compression is applied.

  • level?: number

    Compression level (1-12). Only applies when compress is set.

    • 1: Fastest compression, lowest ratio
    • 6: Default balance of speed and ratio
    • 12: Best compression ratio, slowest