Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PipeArguments

Arguments for the 'pipe()' function of a "pipeline" module.

Hierarchy

Index

Properties

Properties

Optional baseDirectory

baseDirectory: string

The (new) root directory to use.

Optional canceled

canceled: boolean

Indicates if operation has been canceled or not.

context

context: DeployContext

The underlying deploy context.

deployOptions

deployOptions: DeployFileOptions

Deploy options.

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

Optional files

files: string[]

The (new) list of files to deploy.

globals

globals: GlobalVariables

The global variables from the settings.

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.

target

target: DeployTargetPipeline

The target.

targetOptions

targetOptions: any

Options from the target configuration.

Generated using TypeDoc