Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeployWorkspaceArguments

Arguments for deploying the workspace.

Hierarchy

Index

Properties

Properties

Optional canceled

canceled: boolean

Indicates if operation has been canceled or not.

context

context: DeployContext

The underlying deploy context.

Optional data

data: Buffer

The downloaded data.

deployOptions

deployOptions: DeployFileOptions

Deploy options.

direction

direction: DeployDirection

The direction.

emitGlobal

emitGlobal: function

Emits a global event.

param

The event.

param

The arguments.

Type declaration

    • (event: string | symbol, ...args: any[]): boolean

    • Parameters

      • event: string | symbol
      • Rest ...args: any[]

      Returns boolean

files

files: string[]

The list of files to deploy.

Optional globalState

globalState: Object

A state value for the ALL scripts that exists while the current session.

globals

globals: GlobalVariables

The global variables from the settings.

onBeforeDeployFile

onBeforeDeployFile: function

Tells the extension that one of the files IS BEING to be deployed.

param

The file name or its index inside 'files' property.

param

An optional string, like a path or URL, where the file will be deployed.

returns

Event has been raised or not.

Type declaration

    • (file: string | number, destination?: string): boolean

    • Parameters

      • file: string | number
      • Optional destination: string

      Returns boolean

onFileCompleted

onFileCompleted: function

Tells the extension that one of the files HAS BEEN deployed or failed.

param

The file name or its index inside 'files' property.

param

The error (if occurred).

returns

Event has been raised or not.

Type declaration

    • (file: string | number, err?: any): boolean

    • Parameters

      • file: string | number
      • Optional err: any

      Returns boolean

openHtml

openHtml: function

Opens a HTML document in a new tab.

param

The HTML document (source code).

param

The custom title for the tab.

param

The custom ID for the document in the storage.

returns

The promise.

Type declaration

    • (html: string, title?: string, id?: any): Promise<any>

    • Parameters

      • html: string
      • Optional title: string
      • Optional id: any

      Returns Promise<any>

replaceWithValues

replaceWithValues: function

Handles a value as string and replaces placeholders.

param

The value to parse.

returns

The parsed value.

Type declaration

    • (val: any): string

    • Parameters

      • val: any

      Returns string

require

require: function

Loads a module from the script context.

param

The ID / path to the module.

returns

The loaded module.

Type declaration

    • (id: string): any

    • Parameters

      • id: string

      Returns any

sender

sender: any

The underlying "parent" object.

Optional state

state: any

A state value for the current script that exists while the current session.

target

target: DeployTargetScript

The target.

targetOptions

targetOptions: any

Options from the target configuration.

Generated using TypeDoc