Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "contracts"

Index

Enumerations

Interfaces

Type aliases

Variables

Type aliases

BeforeDeployFileEventHandler

BeforeDeployFileEventHandler: function

Describes an event handler that is raised BEFORE a file starts to be deployed.

param

The sending object.

param

The Arguments of the event.

Type declaration

DataTransformer

DataTransformer: function

Describes a function that transforms data into new format.

param

The transformer context.

returns

The result.

DataTransformerResult

DataTransformerResult: Promise<Buffer> | Buffer

Possible results of a data transformer.

DeployScriptOperationExecutor

DeployScriptOperationExecutor: function

A function for a script based deploy operation.

param

The arguments for the execution.

returns

The result.

Type declaration

DeployTargetList

DeployTargetList: string | string[] | DeployTarget | DeployTarget[]

A list of targets.

EventHandler

EventHandler: function

An event handler.

param

The sending object.

param

The arguments for the event.

Type declaration

EventModuleExecutor

EventModuleExecutor: function

Describes a function for executing the logic of an event.

param

The arguments for the execution.

returns

The result.

EventModuleExecutorResult

EventModuleExecutorResult: Promise<number> | number | void

A possible result of an event execution.

FileDeployCompletedEventHandler

FileDeployCompletedEventHandler: function

Describes an event handler that is raised AFTER a file deployment has been completed.

param

The sending object.

param

The Arguments of the event.

Type declaration

GlobalVariables

GlobalVariables: Object

Global variables.

ImportType

ImportType: string | Import

Import types.

PopupButtonAction

PopupButtonAction: function

A popup button action.

Type declaration

    • (): void
    • Returns void

ScriptCommandExecutor

ScriptCommandExecutor: function

Describes the function that execute a command.

param

The arguments for the execution.

returns

The result.

ScriptCommandExecutorResult

ScriptCommandExecutorResult: any

Possible results of a script command.

ScriptValueProvider

ScriptValueProvider: function

A function that provides a script value.

param

The arguments for the underlying script.

returns

The value.

Type declaration

TemplateItemList

TemplateItemList: object

An object with a list of template items.

Type declaration

Validator

Validator: function

A function that validates a value.

param

The arguments.

returns

The promise.

Type declaration

ValueProvider

ValueProvider: function

Describes a function that provides a value.

returns

The value.

Type declaration

    • (): TValue
    • Returns TValue

WorkspaceDeployedEventHandler

WorkspaceDeployedEventHandler: function

Event handler for a completed "deploy workspace" operation.

param

The sending object.

param

Arguments of the event.

Type declaration

Variables

Const DEFAULT_HOST

DEFAULT_HOST: "127.0.0.1" = "127.0.0.1"

Default host address.

Const DEFAULT_HOST_DIR

DEFAULT_HOST_DIR: "./" = "./"

The default directory where remote files should be stored.

Const DEFAULT_MAX_MESSAGE_SIZE

DEFAULT_MAX_MESSAGE_SIZE: 16777215 = 16777215

Default maximum size of a remote JSON message.

Const DEFAULT_PASSWORD_ALGORITHM

DEFAULT_PASSWORD_ALGORITHM: "aes-256-ctr" = "aes-256-ctr"

The default algorithm for crypting data by password.

Const DEFAULT_PORT

DEFAULT_PORT: 23979 = 23979

Default TCP port of a host.

Const EVENT_CANCEL_DEPLOY

EVENT_CANCEL_DEPLOY: "deploy.cancel" = "deploy.cancel"

Name of the event to cancel a deployment.

Const EVENT_CANCEL_PULL

EVENT_CANCEL_PULL: "pull.cancel" = "pull.cancel"

Name of the event to cancel a pull.

Const EVENT_CONFIG_RELOADED

EVENT_CONFIG_RELOADED: "deploy.config.reloaded" = "deploy.config.reloaded"

Name of the event that is raised when configuration has been reloaded.

Const EVENT_DEPLOYFILES

EVENT_DEPLOYFILES: "deploy.deployFiles" = "deploy.deployFiles"

Name of the event that deploys files.

Const EVENT_DEPLOYFILES_COMPLETE

EVENT_DEPLOYFILES_COMPLETE: "deploy.deployFiles.complete" = "deploy.deployFiles.complete"

Name of the event for the 'complete' for the event that deploys files.

Const EVENT_DEPLOYFILES_ERROR

EVENT_DEPLOYFILES_ERROR: "deploy.deployFiles.error" = "deploy.deployFiles.error"

Name of the event for the 'error' for the event that deploys files.

Const EVENT_DEPLOYFILES_SUCCESS

EVENT_DEPLOYFILES_SUCCESS: "deploy.deployFiles.success" = "deploy.deployFiles.success"

Name of the event for the 'success' for the event that deploys files.

Const EVENT_DEPLOYONCHANGE_DISABLE

EVENT_DEPLOYONCHANGE_DISABLE: "deploy.deployOnChange.disable" = "deploy.deployOnChange.disable"

Name of the event that is raised when 'deploy on change' feature should be disabled.

Const EVENT_DEPLOYONCHANGE_ENABLE

EVENT_DEPLOYONCHANGE_ENABLE: "deploy.deployOnChange.enable" = "deploy.deployOnChange.enable"

Name of the event that is raised when 'deploy on change' feature should be enabled.

Const EVENT_DEPLOYONCHANGE_TOGGLE

EVENT_DEPLOYONCHANGE_TOGGLE: "deploy.deployOnChange.toggle" = "deploy.deployOnChange.toggle"

Name of the event that is raised when 'deploy on change' feature should be toggled.

Const EVENT_DEPLOYONSAVE_DISABLE

EVENT_DEPLOYONSAVE_DISABLE: "deploy.deployOnSave.disable" = "deploy.deployOnSave.disable"

Name of the event that is raised when 'deploy on save' feature should be disabled.

Const EVENT_DEPLOYONSAVE_ENABLE

EVENT_DEPLOYONSAVE_ENABLE: "deploy.deployOnSave.enable" = "deploy.deployOnSave.enable"

Name of the event that is raised when 'deploy on save' feature should be enabled.

Const EVENT_DEPLOYONSAVE_TOGGLE

EVENT_DEPLOYONSAVE_TOGGLE: "deploy.deployOnSave.toggle" = "deploy.deployOnSave.toggle"

Name of the event that is raised when 'deploy on save' feature should be toggled.

Const EVENT_SYNCWHENOPEN_DISABLE

EVENT_SYNCWHENOPEN_DISABLE: "deploy.syncWhenOpen.disable" = "deploy.syncWhenOpen.disable"

Name of the event that is raised when 'sync when open' feature should be disabled.

Const EVENT_SYNCWHENOPEN_ENABLE

EVENT_SYNCWHENOPEN_ENABLE: "deploy.syncWhenOpen.enable" = "deploy.syncWhenOpen.enable"

Name of the event that is raised when 'sync when open' feature should be enabled.

Const EVENT_SYNCWHENOPEN_TOGGLE

EVENT_SYNCWHENOPEN_TOGGLE: "deploy.syncWhenOpen.toggle" = "deploy.syncWhenOpen.toggle"

Name of the event that is raised when 'sync when open' feature should be toggled.

Const EVENT_WORKSPACE_CHANGED

EVENT_WORKSPACE_CHANGED: "deploy.workspace.changed" = "deploy.workspace.changed"

Name of the event that is raised when workspace (folder) changed.

Generated using TypeDoc