Optional
bufferedtrue
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
Optional
creationThe creation date.
This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false
.
The current date.
Optional
datatrue
to to add a data descriptor.
When set to false
, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true
.
true
Optional
datatrue
to add the signature of the data descriptor.
false
Optional
encryptionThe encryption strength (AES).
3
Optional
extendedtrue
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
Optional
externalThe external file attribute.
0
Optional
internalThe internal file attribute.
0
Optional
keeptrue
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 zip54
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
Optional
lastThe last access date.
This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false
.
The current date.
Optional
lastThe last modification date.
The current date.
Optional
levelThe level of compression.
The minimum value is 0 and means that no compression is applied. The maximum value is 9.
5
Optional
mimeThe MIME type of the exported data when relevant.
Optional
mstrue
to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.
true
Optional
passwordThe password used to encrypt the content of the entry.
Optional
preventtrue
to prevent closing of WritableWriter#writable.
false
Optional
rawThe password used to encrypt the content of the entry (raw).
Optional
readerThe options passed to the Reader instances
Optional
relativetrue
to use filenames relative to the entry instead of full filenames.
Optional
signalThe AbortSignal
instance used to cancel the compression.
Optional
supportfalse
to never write disk numbers in zip64 data.
true
Optional
usdztrue
to produce zip files compatible with the USDZ specification.
false
Optional
versionThe "Version" field.
Optional
versionThe "Version made by" field.
20
Optional
zip64true
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
Optional
ziptrue
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
Optional
onendOptional
onprogressOptional
onstartGenerated using TypeDoc
Represents the options passed to
{@link ZipDirectoryEntry}#export*()
.