compress.gzip(options)
|
Method Description |
Compresses a file by using gzip and returns it as a temporary file object. 0 is no compression. 9 is the best compression level. |
|
Returns |
|
|
Supported Script Types |
Server scripts For more information, see SuiteScript 2.x Script Types. |
|
Governance |
None |
|
Module |
|
|
Module Members |
|
|
Since |
2020.2 |
Parameters
The options parameter is a JavaScript object.
|
Parameter |
Type |
Required / Optional |
Description |
|---|---|---|---|
|
|
required |
The file to be compressed. |
|
|
|
number |
optional |
The compression level. 0 is no compression. 9 is the best compression level. |
Errors
|
Error Code |
Thrown If |
|---|---|
|
|
The contents of the file to be compressed cannot be retrieved. |
|
|
The specified compression level is outside of the valid range (0 -9). |
|
|
The file cannot be compressed due to size; this happens for files >680MB. Binary/ASCII files have a higher limit of 2GB. |
Syntax
The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/compress Module Script Sample.
// Add additional code
...
var gzippedFile = compress.gzip({
file: myFile,
level: 9
});