CompressionMethod Property

The compression algorithm used.

Syntax

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

Default Value

"zip"

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 property specifies which compression method is used when generating output. Possible values are:

zip (default)
zlib
bzip2
none or uncompressed

Note: The level of compression is controlled by the CompressionLevel setting.

Data Type

String