Global

Members

(constant) DEF_7Z_EXE :string

Source:
Type:
  • string

(constant) DEF_7ZFM_EXE :string

Source:
Type:
  • string

(constant) DEF_DIR_WINRAR :string

Source:
Type:
  • string

Type Definitions

typeDeflateRarOption

Source:
Properties:
Name Type Attributes Default Description
dirWinRar string <optional>
 DEF_DIR_WINRAR

A custom directory path of WinRAR.
isGUI boolean <optional>
 false

true:WinRar.exe false:Rar.exe
workingDir boolean <optional>

Assign a working directory. RAR option: "-w

"
updateMode string <optional>
 "add"

"add" (-u -o+), "sync" (-u -as -o+), "mirror"
skipsExisting boolean <optional>
 false

Skip existing contents
excludingFiles Array.<string> | string <optional>

Exclude specified file
excludesUsingFiles boolean <optional>
 false

Open shared files. RAR option: "-dh"
excludesEmptyDir boolean <optional>
 false

Do not add empty directories. RAR option: "-ed"
excludesSubDirWildcard boolean <optional>
 false

Recurse subdirectories for wildcard names only. RAR option: "-r0"
expandsPathsToFull boolean <optional>
 false

true: Expand paths to full (-ep2). false (default): Exclude base directory from names (ep1)
compressLv number <optional>
 5

Set compression level (0-store...3-default...5-maximal). RAR option: "-m<0..5>"
cpuPriority number <optional>
 0

Set processing priority (0-default,1-min..15-max) and sleep time in ms
recoveryPer number <optional>
 3

Add data recovery record
password string <optional>

Encrypt both file data and headers. RAR option: "-hp[password]"
dateCode string <optional>

If specify "yyyy-MM-dd" to Rar file name is _yyyy-MM-dd.rar
excludesADS boolean <optional>
 false

Do not save NTFS streams. (ADS: NTFS Alternate Data Stream. RAR option: "-os"
containsSecArea boolean <optional>
 false

Save or restore file owner and group. RAR option: "-ow"
isSolidArchive boolean <optional>
 true

Create solid archive
assumesYes boolean <optional>
 true

Assume Yes on all queries
sendAllMesToStdErr boolean <optional>
 false

Send all messages to stderr. RAR option: "-ierr"
rarVersion number <optional>
 5

Specify a version of archiving format. RAR option: "-ma5"
isSymlinkAsLink boolean <optional>
 false

Process symbolic links as the link(RAR 4.x以上、Linuxのみ？) RAR option: "-ol"
savesTmpList boolean <optional>
 false

Does not remove temporary file list.
outputsLog boolean <optional>
 false

Output console logs.
isDryRun boolean <optional>
 false

No execute, returns the string of command.
Type:
  • object

typeDeflateResult

Source:
Properties:
Name Type Description
command string

A executable command line
archivedPath string

An archived file path
error boolean

Error or not.
stdout string

Std Output.
stderr string

Std Error.
Type:
  • object

typeDeflateZipOption

Source:
Properties:
Name Type Attributes Default Description
exe7z string <optional>
 DEF_7ZIP_EXE

A custom .exe path of 7-ZIP.
workingDir string <optional>

Working directory
updateMode boolean <optional>
 'sync'

A method of overwriting an existing dest Zip file. "sync" (default) or "add"
includesSubDir boolean <optional>

How to interpret the specified path (src, dest, excludingFiles). default: recurse subdirectories only when using wildcard. true: recurse subdirectories. false: disable recurse subdirectories.
excludingFiles Array.<string> | string <optional>

You should specify relative paths with a wildcard. Cannot establish absolute paths.
compressLv number | string <optional>
 5

Level of compression. 1,3,5,7,9 or Fastest, Fast, Normal, Maximum, Ultra
password string <optional>

Specifies password. File names will not be encrypted in Zip archive.
dateCode string <optional>

If specify "yyyy-MM-dd" to Zipfile name is _yyyy-MM-dd.zip
savesTmpList boolean <optional>
 false

Does not remove temporary file list.
outputsLog boolean <optional>
 false

Output console logs.
isDryRun boolean <optional>
 false

No execute, returns the string of command.
Type:
  • object