@zip.js/zip.js
    Preparing search index...

    Interface ZipWriterAddDataOptions

    Represents the options passed to ZipWriter#add.

    interface ZipWriterAddDataOptions {
        bufferedWrite?: boolean;
        comment?: string;
        compressionMethod?: number;
        creationDate?: Date;
        dataDescriptor?: boolean;
        dataDescriptorSignature?: boolean;
        directory?: boolean;
        encrypted?: boolean;
        encryptionStrength?: 1 | 2 | 3;
        executable?: boolean;
        extendedTimestamp?: boolean;
        externalFileAttributes?: number;
        extraField?: Map<number, Uint8Array<ArrayBuffer>>;
        internalFileAttributes?: number;
        keepOrder?: boolean;
        lastAccessDate?: Date;
        lastModDate?: Date;
        level?: number;
        msDosCompatible?: boolean;
        offset?: number;
        passThrough?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array<ArrayBuffer>;
        signal?: AbortSignal;
        signature?: number;
        supportZip64SplitFile?: boolean;
        uncompressedSize?: number;
        usdz?: boolean;
        useCompressionStream?: boolean;
        useUnicodeFileNames?: boolean;
        useWebWorkers?: boolean;
        version?: number;
        versionMadeBy?: number;
        zip64?: boolean;
        zipCrypto?: boolean;
        encodeText(text: string): Uint8Array<ArrayBuffer>;
        onend(computedSize: number): Promise<void>;
        onprogress(progress: number, total: number): Promise<void>;
        onstart(total: number): Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    bufferedWrite? comment? compressionMethod? creationDate? dataDescriptor? dataDescriptorSignature? directory? encrypted? encryptionStrength? executable? extendedTimestamp? externalFileAttributes? extraField? internalFileAttributes? keepOrder? lastAccessDate? lastModDate? level? msDosCompatible? offset? passThrough? password? preventClose? rawPassword? signal? signature? supportZip64SplitFile? uncompressedSize? usdz? useCompressionStream? useUnicodeFileNames? useWebWorkers? version? versionMadeBy? zip64? zipCrypto?

    Methods

    encodeText? onend? onprogress? onstart?

    Properties

    bufferedWrite?: boolean

    true to write entry data in a buffer before appending it to the zip file.

    bufferedWrite is automatically set to true when compressing more than one entry in parallel.

    false
    comment?: string

    The comment of the entry.

    compressionMethod?: number

    The compression method (e.g. 8 for DEFLATE, 0 for STORE).

    creationDate?: Date

    The creation date.

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    The current date.
    dataDescriptor?: boolean

    true to add a data descriptor.

    When set to false, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true.

    true
    dataDescriptorSignature?: boolean

    true to add the signature of the data descriptor.

    false
    directory?: boolean

    true if the entry is a directory.

    false
    encrypted?: boolean

    true to write encrypted data when passThrough is set to true.

    encryptionStrength?: 1 | 2 | 3

    The encryption strength (AES):

    • 1: 128-bit encryption key
    • 2: 192-bit encryption key
    • 3: 256-bit encryption key
    3
    executable?: boolean

    true if the entry is an executable file.

    false
    extendedTimestamp?: boolean

    true to store extended timestamp extra fields.

    When set to false, the maximum last modification date cannot exceed November 31, 2107 and the maximum accuracy is 2 seconds.

    true
    externalFileAttributes?: number

    The external file attribute.

    0
    extraField?: Map<number, Uint8Array<ArrayBuffer>>

    The extra field of the entry.

    internalFileAttributes?: number

    The internal file attribute.

    0
    keepOrder?: boolean

    true to keep the order of the entry physically in the zip file.

    When set to true, the use of web workers will be improved. However, it also prevents files larger than 4GB from being created without setting the zip64 option to true explicitly. Another solution to improve the use of web workers is to add entries from smallest to largest in uncompressed size.

    true
    lastAccessDate?: Date

    The last access date.

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    The current date.
    lastModDate?: Date

    The last modification date.

    The current date.
    level?: number

    The level of compression.

    The minimum value is 0 and means that no compression is applied. The maximum value is 9.

    5
    msDosCompatible?: boolean

    true to write EntryMetaData#externalFileAttributes in MS-DOS format for folder entries.

    false
    offset?: number

    The offset of the first entry in the zip file.

    passThrough?: boolean

    true to write the data as-is without compressing it and without crypting it.

    password?: string

    The password used to encrypt the content of the entry.

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    false
    rawPassword?: Uint8Array<ArrayBuffer>

    The password used to encrypt the content of the entry (raw).

    signal?: AbortSignal

    The AbortSignal instance used to cancel the compression.

    signature?: number

    The signature (CRC32 checksum) of the content. This option is ignored if the ZipWriterConstructorOptions#passThrough option is not set to true.

    supportZip64SplitFile?: boolean

    false to never write disk numbers in zip64 data.

    true
    uncompressedSize?: number

    The uncompressed size of the entry. This option is ignored if the ZipWriterConstructorOptions#passThrough option is not set to true.

    usdz?: boolean

    trueto produce zip files compatible with the USDZ specification.

    false
    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    true
    useUnicodeFileNames?: boolean

    true to mark the file names as UTF-8 setting the general purpose bit 11 in the header (see Appendix D - Language Encoding (EFS)), false to mark the names as compliant with the original IBM Code Page 437.

    Note that this does not ensure that the file names are in the correct encoding.

    true
    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    true
    version?: number

    The "Version" field.

    versionMadeBy?: number

    The "Version made by" field.

    20
    zip64?: boolean

    true to use Zip64 to store the entry.

    zip64 is automatically set to true when necessary (e.g. compressed data larger than 4GB or with unknown size).

    false
    zipCrypto?: boolean

    true to use the ZipCrypto algorithm to encrypt the content of the entry.

    It is not recommended to set zipCrypto to true because the ZipCrypto encryption can be easily broken.

    false

    Methods

    • The function called for encoding the filename and the comment of the entry.

      Parameters

      • text: string

        The text to encode.

      Returns Uint8Array<ArrayBuffer>

      The encoded text or undefined if the text should be encoded by zip.js.

    • The function called when ending compression/decompression.

      Parameters

      • computedSize: number

        The total number of bytes (computed).

      Returns Promise<void>

      An empty promise or undefined.

    • The function called during compression/decompression.

      Parameters

      • progress: number

        The current progress in bytes.

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

    • The function called when starting compression/decompression.

      Parameters

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods