compress.gunzip(options)
Method Description |
Decompresses a file that was compressed using gzip and returns it as a temporary file object. |
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 decompressed. |
Errors
Error Code |
Thrown If |
---|---|
|
The file cannot be decompressed. |
|
The contents of the file to be decompressed cannot be retrieved. |
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 gunzippedFile = compress.gunzip({
file: gzippedFile
});