Class ScriptPlugin

Hierarchy

DeployPluginBase
- ScriptPlugin

Implements

DeployPlugin
Disposable

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ScriptPlugin(ctx?: DeployContext): ScriptPlugin

Inherited from DeployPluginBase.constructor
- Defined in objects.ts:75
Initializes a new instance of that class.

Parameters
- Optional ctx: DeployContext
Returns ScriptPlugin

Properties

Protected _context

_context: DeployContext

Stores the deploy context.

Protected _globalState

_globalState: Object

Protected _scriptStates

_scriptStates: Object

Accessors

canGetFileInfo

get canGetFileInfo(): boolean

Overrides DeployPluginBase.canGetFileInfo
- Defined in plugins/script.ts:211
Returns boolean

canPull

get canPull(): boolean

Overrides DeployPluginBase.canPull
- Defined in plugins/script.ts:215
Returns boolean

context

get context(): DeployContext

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

Returns DeployContext

Methods

compareFiles

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

Inherited from DeployPluginBase.compareFiles
- 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[]>

Inherited from DeployPluginBase.compareWorkspace
- 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

Inherited from DeployPluginBase.createDataTransformerContext
- 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

deployFile

deployFile(file: string, target: DeployTargetScript, opts?: DeployFileOptions): void

Overrides DeployPluginBase.deployFile
- Defined in plugins/script.ts:219
Parameters
- file: string
- target: DeployTargetScript
- Optional opts: DeployFileOptions
Returns void

Protected deployOrPullFile

deployOrPullFile(direction: DeployDirection, file: string, target: DeployTargetScript, opts?: DeployFileOptions): Promise<DeployFileArguments>

- Defined in plugins/script.ts:224
Parameters
- direction: DeployDirection
- file: string
- target: DeployTargetScript
- Optional opts: DeployFileOptions
Returns Promise<DeployFileArguments>

Protected deployOrPullWorkspace

deployOrPullWorkspace(direction: DeployDirection, files: string[], target: DeployTargetScript, opts?: DeployWorkspaceOptions): Promise<DeployWorkspaceArguments>

- Defined in plugins/script.ts:382
Parameters
- direction: DeployDirection
- files: string[]
- target: DeployTargetScript
- Optional opts: DeployWorkspaceOptions
Returns Promise<DeployWorkspaceArguments>

deployWorkspace

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

Overrides DeployPluginBase.deployWorkspace
- Defined in plugins/script.ts:377
Parameters
- files: string[]
- target: DeployTargetScript
- Optional opts: DeployWorkspaceOptions
Returns void

dispose

dispose(): void

Inherited from DeployPluginBase.dispose
- Defined in objects.ts:333
inheritdoc

Returns void

downloadFile

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

Overrides DeployPluginBase.downloadFile
- Defined in plugins/script.ts:561
Parameters
- file: string
- target: DeployTargetScript
- Optional opts: DeployFileOptions
Returns Promise<Buffer>

getFileInfo

getFileInfo(file: string, target: DeployTargetScript, opts?: DeployFileOptions): Promise<FileInfo>

Overrides DeployPluginBase.getFileInfo
- Defined in plugins/script.ts:573
Parameters
- file: string
- target: DeployTargetScript
- Optional opts: DeployFileOptions
Returns Promise<FileInfo>

Protected getTargetsWithPlugins

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

Inherited from DeployPluginBase.getTargetsWithPlugins
- 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.

info

info(): DeployPluginInfo

- Defined in plugins/script.ts:588
Returns DeployPluginInfo

Protected loadDataTransformer

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

Inherited from DeployPluginBase.loadDataTransformer
- 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

Inherited from DeployPluginBase.onCancelling
- 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

Overrides DeployPluginBase.onConfigReloaded
- Defined in plugins/script.ts:594
Parameters
- cfg: DeployConfiguration
Returns void

pullFile

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

Inherited from DeployPluginBase.pullFile
- 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

Inherited from DeployPluginBase.pullWorkspace
- Defined in objects.ts:573
inheritdoc

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

Generated using TypeDoc