CompressionAlgorithm Property

The compression algorithm to use.

Syntax

 pgpwriter.getCompressionAlgorithm([callback])
 pgpwriter.setCompressionAlgorithm( compressionAlgorithm, [callback])

Default Value

"Uncompressed"

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 getCompressionAlgorithm([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 setCompressionAlgorithm([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

Use this property to specify the compression algorithm to use before encrypting the data. This property only makes sense if Compress is True.

Data Type

String