Interface AddEntryOptions

The options for adding an entry to the ZIP archive.

interface AddEntryOptions {
    bufferedWrite?: boolean;
    comment?: string;
    compressionMethod?: number;
    creationDate?: Date;
    dataDescriptor?: boolean;
    dataDescriptorSignature?: boolean;
    directory?: boolean;
    encrypted?: boolean;
    encryptionStrength?: 2 | 1 | 3;
    extendedTimestamp?: boolean;
    externalFileAttribute?: number;
    extraField?: Map<number, Uint8Array>;
    internalFileAttribute?: number;
    keepOrder?: boolean;
    lastAccessDate?: Date;
    lastModDate?: Date;
    level?: number;
    log?: Log;
    msDosCompatible?: boolean;
    offset?: number;
    passThrough?: boolean;
    password?: string;
    preventClose?: boolean;
    rawPassword?: Uint8Array;
    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): undefined | Uint8Array;
    onend?(computedSize: number): undefined | Promise<void>;
    onprogress?(progress: number, total: number): undefined | Promise<void>;
    onstart?(total: number): undefined | Promise<void>;
}

Hierarchy

  • ZipWriterAddDataOptions
    • AddEntryOptions

Properties

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

Methods

encodeText? onend? onprogress? onstart?

Properties

OptionalbufferedWrite

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.

Default Value

false

Optionalcomment

comment?: string

The comment of the entry.

OptionalcompressionMethod

compressionMethod?: number

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

OptionalcreationDate

creationDate?: Date

The creation date.

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

Default Value

The current date.

OptionaldataDescriptor

dataDescriptor?: boolean

true to add a data descriptor.

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

Default Value

true

OptionaldataDescriptorSignature

dataDescriptorSignature?: boolean

true to add the signature of the data descriptor.

Default Value

false

Optionaldirectory

directory?: boolean

true if the entry is a directory.

Default Value

false

Optionalencrypted

encrypted?: boolean

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

OptionalencryptionStrength

encryptionStrength?: 2 | 1 | 3

The encryption strength (AES).

Default Value

3

OptionalextendedTimestamp

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.

Default Value

true

OptionalexternalFileAttribute

externalFileAttribute?: number

The external file attribute.

Default Value

0

OptionalextraField

extraField?: Map<number, Uint8Array>

The extra field of the entry.

OptionalinternalFileAttribute

internalFileAttribute?: number

The internal file attribute.

Default Value

0

OptionalkeepOrder

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.

Default Value

true

OptionallastAccessDate

lastAccessDate?: Date

The last access date.

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

Default Value

The current date.

OptionallastModDate

lastModDate?: Date

The last modification date.

Default Value

The current date.

Optionallevel

level?: number

The level of compression.

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

Default Value

5

Optionallog

log?: Log

The logger for logging messages.

OptionalmsDosCompatible

msDosCompatible?: boolean

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

Default Value

true

Optionaloffset

offset?: number

The offset of the first entry in the zip file.

OptionalpassThrough

passThrough?: boolean

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

Optionalpassword

password?: string

The password used to encrypt the content of the entry.

OptionalpreventClose

preventClose?: boolean

true to prevent closing of WritableWriter#writable.

Default Value

false

OptionalrawPassword

rawPassword?: Uint8Array

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

Optionalsignal

signal?: AbortSignal

The AbortSignal instance used to cancel the compression.

Optionalsignature

signature?: number

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

OptionalsupportZip64SplitFile

supportZip64SplitFile?: boolean

false to never write disk numbers in zip64 data.

Default Value

true

OptionaluncompressedSize

uncompressedSize?: number

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

Optionalusdz

usdz?: boolean

trueto produce zip files compatible with the USDZ specification.

Default Value

false

OptionaluseCompressionStream

useCompressionStream?: boolean

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

Default Value

true

OptionaluseUnicodeFileNames

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.

Default Value

true

OptionaluseWebWorkers

useWebWorkers?: boolean

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

Default Value

true

Optionalversion

version?: number

The "Version" field.

OptionalversionMadeBy

versionMadeBy?: number

The "Version made by" field.

Default Value

20

Optionalzip64

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).

Default Value

false

OptionalzipCrypto

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.

Default Value

false

Methods

OptionalencodeText

  • encodeText(text): undefined | Uint8Array

  • Encode the filename and the comment of the entry.

    Parameters

    • text: string

      The text to encode.

    Returns undefined | Uint8Array

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

Optionalonend

  • onend(computedSize): undefined | Promise<void>

  • The function called when ending compression/decompression.

    Parameters

    • computedSize: number

      The total number of bytes (computed).

    Returns undefined | Promise<void>

    An empty promise or undefined.

Optionalonprogress

  • onprogress(progress, total): undefined | Promise<void>

  • The function called during compression/decompression.

    Parameters

    • progress: number

      The current progress in bytes.

    • total: number

      The total number of bytes.

    Returns undefined | Promise<void>

    An empty promise or undefined.

Optionalonstart

  • onstart(total): undefined | Promise<void>

  • The function called when starting compression/decompression.

    Parameters

    • total: number

      The total number of bytes.

    Returns undefined | Promise<void>

    An empty promise or undefined.

Settings

Member Visibility

On This Page

Properties
Methods