compress.gzip(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

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	file.File
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/compress Module
Module Members	N/compress Module Members
Since	2020.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
options.file	file.File	required	The file to be compressed.
options.level	number	optional	The compression level. 0 is no compression. 9 is the best compression level.

Errors

Error Code	Thrown If
COMPRESS_API_UNABLE_TO_RETRIEVE_FILE_CONTENTS	The contents of the file to be compressed cannot be retrieved.
COMPRESS_API_COMPRESSION_LEVEL_OUT_OF_RANGE	The specified compression level is outside of the valid range (0 - 9).

Syntax

Important:

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
}); 

          

Related Topics

N/compress Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices