IPWorks ZIP 2020 Node.js Edition

Questions / Feedback?

CompressionMethod Property

Used to set the method of compression.

Syntax

 sevenzip.getCompressionMethod([callback])
 sevenzip.setCompressionMethod( compressionMethod, [callback])

Possible Values

  0 (cmszLzma), 
  1 (cmszBzip2), 
  2 (cmszDelta), 
  3 (cmszCopy), 
  4 (cmszDeflate), 
  5 (cmszLzma2)

Default Value

0

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 getCompressionMethod([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setCompressionMethod([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

This is used to specify different compression methods. By default the class uses the LZMA compression method (a value of 0). Supported values are:

ValueMethod
cmszLzma (0 - default) LZMA
cmszBzip2 (1) BZip2
cmszDelta (2) Delta
cmszCopy (3) Copy (no compression)
cmszDeflate (4) Deflate
cmszLzma2 (5) LZMA2

Data Type

Integer

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