This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
misc:validzipmethod [2017/05/25 14:10] willam |
misc:validzipmethod [2020/02/26 17:10] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== validZipMethod() ====== | ||
+ | Function to check whether the specified zip method is a supported zip method. | ||
+ | Valid methods are: | ||
+ | |||
+ | ^ Method ^ Meaning ^ | ||
+ | | tz7b | 7z format | | ||
+ | | tgzip | GZIP format | | ||
+ | | tzip | ZIP format | | ||
+ | | tbzip| BZIP2 format | | ||
+ | | tiso | ISO format | | ||
+ | | tudf | UDF format | | ||
+ | |||
+ | ===== Usage ===== | ||
+ | <code javascript> | ||
+ | var zipmethod = "tzip"; | ||
+ | if(validZipMethod(zipmethod)) { | ||
+ | file.zip("myarchive.zip", zipmethod, 5, "a"); | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | ===== Parameters ===== | ||
+ | ^ Parameter ^ Data type ^ Required ^ Description ^ | ||
+ | | method | string | True | The zip method to check | | ||
+ | |||
+ | ===== Return Values ===== | ||
+ | ^ Value ^ Meaning ^ | ||
+ | | true | The command is a valid zip method | | ||
+ | | false | The command is not a valid zip method | |