Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeployFileArguments

Arguments for deploying a file.

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

file

file: string

The file 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.

info

info: FileInfo

The property where to write the file info to.

onBeforeDeploy

onBeforeDeploy: function

Tells the extension that the underlying file IS BEING to be deployed.

param

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

returns

Event has been raised or not.

Type declaration

    • (destination?: string): boolean

    • Parameters

      • Optional destination: string

      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