Global

Type Definitions

typeSchemaArchiverTask

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

The task description.

available boolean <optional>
true

If specifying false, Skips the task.

srcDir string

The source directory path to archive.

dest string

The destination path.

archiveType string

The archiving method, 'ZIP' or 'RAR'

{boolean} string

[forEachSubDir=true] - Compresses each sub directory in the specified source directory.

includesEmptyDir boolean <optional>
false

Compresses empty directories.

includesSymlink boolean <optional>

Copies symbolic link.

matchedRegExp string | Array <optional>

e.g. "^[^.].+$"

ignoredRegExp string | Array <optional>

e.g. "\.git.*"

throws boolean <optional>
false

Throws a error.

Type:
  • typeDeflateZipOption | typeDeflateRarOption

typeSchemaBackUpper

Source:
Properties:
Name Type Attributes Description
description string <optional>
components object <optional>
tasks typeSchemaBackUpperTask | typeSchemaArchiverTask
Type:
  • object

typeSchemaBackUpperTask

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

The task description.

available boolean <optional>
true

If specifying false, Skips the task.

srcDir string

The source directory path to back up.

destDir string

The destination directory path.

syncMethod string <optional>

The synchronization method. "UPDATE" or "MIRROR".

comparison string <optional>

"TIME" or "CONTENT".

isRecursive boolean <optional>

Copies sub directories.

copiesEmpDir boolean <optional>

Copies empty directories.

includesSymlink boolean <optional>

Copies symbolic link.

matchedRegExp string | Array <optional>

e.g. "\w+\.txt$"

ignoredRegExp string | Array <optional>

e.g. "\.tmp$"

throws boolean <optional>
false

Throws a error.

Type:
  • object