Extract Method

Extracts the compressed file from the archive.

Syntax

zcompress.extract([callback])

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 this 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

Invoking Extract decompresses the archive specified by ArchiveFile. The compressed file will be extracted, and written to disk.

If FileDecompressedName is set to a nonempty string the file will be written there. Otherwise the class will automatically set FileDecompressedName to an appropriate value:

If FileDecompressedName is empty and ArchiveFile ends in ".Z", this filename, less the ".Z" extension will be used. Otherwise the extension ".uncompressed" will be appended to the file name.