asynczipoptions.md 3.3 KB
Interface: AsyncZipOptions
Options for asynchronously creating a ZIP archive
Hierarchy
↳ AsyncZipOptions
Index
Properties
Properties
attrs
• Optional attrs: number
Inherited from ZipAttributes.attrs
The file's attributes. These are traditionally somewhat complicated and platform-dependent, so using them is scarcely necessary. However, here is a representation of what this is, bit by bit:
TTTTugtrwxrwxrwx0000000000ADVSHR
TTTT = file type (rarely useful)
u = setuid, g = setgid, t = sticky
rwx = user permissions, rwx = group permissions, rwx = other permissions
0000000000 = unused
A = archive, D = directory, V = volume label, S = system file, H = hidden, R = read-only
If you want to set the Unix permissions, for instance, just bit shift by 16, e.g. 0644 << 16
consume
• Optional consume: boolean
Inherited from AsyncDeflateOptions.consume
Whether or not to "consume" the source data. This will make the typed array/buffer you pass in unusable but will increase performance and reduce memory usage.
level
• Optional level: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
Inherited from DeflateOptions.level
The level of compression to use, ranging from 0-9.
0 will store the data without compression. 1 is fastest but compresses the worst, 9 is slowest but compresses the best. The default level is 6.
Typically, binary data benefits much more from higher values than text data. In both cases, higher values usually take disproportionately longer than the reduction in final size that results.
For example, a 1 MB text file could:
- become 1.01 MB with level 0 in 1ms
- become 400 kB with level 1 in 10ms
- become 320 kB with level 9 in 100ms
mem
• Optional mem: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12
Inherited from DeflateOptions.mem
The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.
Note that this is exponential: while level 0 uses 4 kB, level 4 uses 64 kB, level 8 uses 1 MB, and level 12 uses 16 MB. It is recommended not to lower the value below 4, since that tends to hurt performance. In addition, values above 8 tend to help very little on most data and can even hurt performance.
The default value is automatically determined based on the size of the input data.
mtime
• Optional mtime: GzipOptions[\"mtime\"]
Inherited from ZipAttributes.mtime
When the file was last modified. Defaults to the current time.
os
• Optional os: number
Inherited from ZipAttributes.os
The operating system of origin for this file. The value is defined by PKZIP's APPNOTE.txt, section 4.4.2.2. For example, 0 (the default) is MS/DOS, 3 is UNIX, 19 is macOS.