Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeployPlugin

A plugin.

Hierarchy

  • DeployPlugin

Implemented by

Index

Properties

Properties

Optional __file

__file: string

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the filename of the plugin.

Optional __filePath

__filePath: string

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the full path of the plugin's file.

Optional __index

__index: number

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the index of the plugin.

Optional __type

__type: string

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the type of the plugin.

Optional canGetFileInfo

canGetFileInfo: boolean

Indicates if plugin is able to get information about remote files or not.

Optional canPull

canPull: boolean

Indicates if plugin can pull files or not.

Optional compareFiles

compareFiles: function

Compares a local file with a remote one.

param

The file to compare.

param

The source from where to download the file from.

param

Additional options.

returns

The result.

Type declaration

Optional compareWorkspace

compareWorkspace: function

Compares local files with a remote ones.

param

The files to compare.

param

The source from where to download the file from.

param

Additional options.

returns

The result.

Type declaration

Optional deployFile

deployFile: function

Deploys a file.

param

The path of the local file.

param

The target.

param

Additional options.

Type declaration

Optional deployWorkspace

deployWorkspace: function

Deploys files of a workspace.

param

The files to deploy.

param

The target.

param

Additional options.

Type declaration

Optional dispose

dispose: function

Disposes / cleanup the plugin.

Type declaration

    • (): void

    • Returns void

Optional downloadFile

downloadFile: function

Downloads a file from target.

param

The file to download.

param

The source from where to download the file from.

param

Additional options.

returns

The promise.

Type declaration

Optional getFileInfo

getFileInfo: function

Gets information about a file from target.

param

The file to download.

param

The source from where to download the file from.

param

Additional options.

returns

The result.

Type declaration

Optional info

info: function

Return information of the plugin.

returns

The plugin info.

Type declaration

Optional pullFile

pullFile: function

Pulls a file.

param

The path of the local file.

param

The target that contains the file to pull.

param

Additional options.

Type declaration

Optional pullWorkspace

pullWorkspace: function

Pulls files of to the workspace.

param

The files to pull.

param

The target that contains the files to pull.

param

Additional options.

Type declaration

Generated using TypeDoc