CompressionLevel Property

The compression level to use.

Syntax

 gzip.getCompressionLevel([callback])
 gzip.setCompressionLevel( compressionLevel, [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 getCompressionLevel([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 setCompressionLevel([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 the level of compression to be used, between 1 and 6. Higher values will cause the class to compress better; lower values will cause the class to compress faster.

Storing without compression is not supported for Gzip.

Data Type

Integer