Class DeployPluginBase

A basic deploy plugin that is specially based on single file operations (s. deployFile() method).

Hierarchy

DeployPluginBase

Implements

DeployPlugin
Disposable

Index

Constructors

constructor

Properties

_context

Accessors

Methods

Constructors

constructor

new DeployPluginBase(ctx?: DeployContext): DeployPluginBase

- Defined in objects.ts:75
Initializes a new instance of that class.

Parameters
- Optional ctx: DeployContext
Returns DeployPluginBase

Properties

Protected _context

_context: DeployContext

Stores the deploy context.

Accessors

canGetFileInfo

get canGetFileInfo(): boolean

- Defined in objects.ts:90
Indicates if plugin is able to get information about remote files or not.

inheritdoc

Returns boolean

canPull

get canPull(): boolean

- Defined in objects.ts:95
Indicates if plugin can pull files or not.

inheritdoc

Returns boolean

context

get context(): DeployContext

- Defined in objects.ts:201
Gets the underlying deploy context.

Returns DeployContext

Methods

compareFiles

compareFiles(file: string, target: DeployTarget, opts?: DeployFileOptions): Promise<FileCompareResult>

- Defined in objects.ts:100
inheritdoc

Parameters
- file: string
- target: DeployTarget
- Optional opts: DeployFileOptions
Returns Promise<FileCompareResult>

compareWorkspace

compareWorkspace(files: string[], target: DeployTarget, opts?: DeployFileOptions): Promise<FileCompareResult[]>

- Defined in objects.ts:177
inheritdoc

Parameters
- files: string[]
- target: DeployTarget
- Optional opts: DeployFileOptions
Returns Promise<FileCompareResult[]>

Protected createDataTransformerContext

createDataTransformerContext(target: TransformableDeployTarget, mode: DataTransformerMode, subCtx?: any): DataTransformerContext

- Defined in objects.ts:212
Creates a basic data transformer context.

Parameters
- target: TransformableDeployTarget
  
  The target.
- mode: DataTransformerMode
  
  The mode.
- Default value subCtx: any = {}
Returns DataTransformerContext

Abstract deployFile

deployFile(file: string, target: DeployTarget, opts?: DeployFileOptions): any

- Defined in objects.ts:238
inheritdoc

Parameters
- file: string
- target: DeployTarget
- Optional opts: DeployFileOptions
Returns any

deployWorkspace

deployWorkspace(files: string[], target: DeployTarget, opts?: DeployWorkspaceOptions): void

- Defined in objects.ts:241
inheritdoc

Parameters
- files: string[]
- target: DeployTarget
- Optional opts: DeployWorkspaceOptions
Returns void

dispose

dispose(): void

- Defined in objects.ts:333
inheritdoc

Returns void

downloadFile

downloadFile(file: string, target: DeployTarget, opts?: DeployFileOptions): Promise<Buffer> | Buffer

- Defined in objects.ts:339
inheritdoc

Parameters
- file: string
- target: DeployTarget
- Optional opts: DeployFileOptions
Returns Promise<Buffer> | Buffer

getFileInfo

getFileInfo(file: string, target: DeployTarget, opts?: DeployFileOptions): PromiseLike<FileInfo> | FileInfo

- Defined in objects.ts:344
inheritdoc

Parameters
- file: string
- target: DeployTarget
- Optional opts: DeployFileOptions
Returns PromiseLike<FileInfo> | FileInfo

Protected getTargetsWithPlugins

getTargetsWithPlugins(target: DeployTarget, otherTargets: string | string[]): DeployTargetWithPlugins[]

- Defined in objects.ts:356
Returns the others targets and their plugins.

Parameters
- target: DeployTarget
  
  The target for this plugin.
- otherTargets: string | string[]
  
  The list of names of the "others" targets.
Returns DeployTargetWithPlugins[]

The targets and their plugins.

Protected loadDataTransformer

loadDataTransformer<TTarget>(target: TTarget, mode: DataTransformerMode, scriptProvider?: function): deploy_contracts.DataTransformer

- Defined in objects.ts:429
Loads a data transformer by target.

Type parameters
- TTarget: TransformableDeployTarget
Parameters
- target: TTarget
  
  The target.
- mode: DataTransformerMode
  
  The mode.
- Optional scriptProvider: function
  - - (t: TTarget): string
    - Parameters
      - t: TTarget
      Returns string
Returns deploy_contracts.DataTransformer

The loaded transformer.

Protected onCancelling

onCancelling(callback: deploy_contracts.EventHandler, opts?: DeployFileOptions | DeployWorkspaceOptions): void

- Defined in objects.ts:470
Registers for a callback for a 'cancel' event that is called once.

Parameters
- callback: deploy_contracts.EventHandler
  
  The callback to register.
- Optional opts: DeployFileOptions | DeployWorkspaceOptions
Returns void

Protected onConfigReloaded

onConfigReloaded(cfg: DeployConfiguration): void

- Defined in objects.ts:489
Is invoked after app config has been reloaded.

Parameters
- cfg: DeployConfiguration
  
  The new config.
Returns void

pullFile

pullFile(file: string, target: DeployTarget, opts?: DeployFileOptions): void

- Defined in objects.ts:493
inheritdoc

Parameters
- file: string
- target: DeployTarget
- Optional opts: DeployFileOptions
Returns void

pullWorkspace

pullWorkspace(files: string[], target: DeployTarget, opts?: DeployWorkspaceOptions): void

- Defined in objects.ts:573
inheritdoc

Parameters
- files: string[]
- target: DeployTarget
- Optional opts: DeployWorkspaceOptions
Returns void

Generated using TypeDoc