minigame-std
    Preparing search index...

    Interface ZipOptions

    Options for zip.

    1.6.0

    interface ZipOptions {
        level?: ZipLevel;
        preserveRoot?: boolean;
    }
    Index
    level? preserveRoot?
    level?: ZipLevel

    Compression level for the zip operation.

    • 0: No compression (store only) — best for already-compressed data
    • 1: Fastest compression
    • 6: Default compression (balanced)
    • 9: Best compression (slowest)

    Aligns with fflate's DeflateOptions.level.

    6

    2.1.0

    // Store without compression (for already-compressed files like images/videos)
    await zip('/photos', '/photos.zip', { level: 0 });

    // Best compression (for text-heavy data, slower)
    await zip('/documents', '/documents.zip', { level: 9 });
    preserveRoot?: boolean

    Whether to preserve the root directory name in the zip file structure.

    • true: /path/to/folder → folder/file1.txt, folder/file2.txt
    • false: /path/to/folder → file1.txt, file2.txt

    true

    Settings
    Member Visibility

    On This Page
    Properties