IPWorks ZIP 2020 Node.js Edition

Questions / Feedback?

ZipData Property

(Decompression only) The zip file contents as a byte array.

Syntax

 zip.getZipData([callback])
 zip.setZipData( zipData_Buffer, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getZipData([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setZipData([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Normally you should set ArchiveFile before invoking Scan or Extract. If you prefer to read the zip file from memory you may set ZipData instead. ZipData should be set to the entire contents of the zip file; this will allow you to read from the archive without writing any temporary files to disk.

If you would like to extract data from the archive without ever writing to disk you should also set WriteToProgressEvent to true, and after invoking Scan, you should set the value of FileDecompressedName for each file in the Files collection to an empty string. Then, when you invoke Extract (or ExtractAll) the data will be provided in the Progress event.

This property is write-only. Note that modifying a zip file stored in ZipData is not supported, so Append, Delete, etc., will throw exceptions.

This property is not available at design time.

Data Type

Buffer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks ZIP 2020 Node.js Edition - Version 20.0 [Build 8300]