Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AppTarget

An 'app' target.

Hierarchy

Index

Properties

__cache

__cache: CacheProvider

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

The cache for that item.

__id

__id: any

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the ID of that item.

__index

__index: number

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the zero-based of that item.

__searchValue

__searchValue: any

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

A value for comparison.

__workspace

__workspace: Workspace

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the underlying workspace.

app

app: string

The app / shell command.

Optional appendOperationFlag

appendOperationFlag: boolean

Append operation flag to argument list (true) or add as first argument (false).

Optional applyValuesTo

applyValuesTo: object

A list of property names and their values that should be applied to that object.

Type declaration

  • [prop: string]: any

Optional argumentScriptOptions

argumentScriptOptions: any

Options for a script that provides arguments.

Optional arguments

arguments: string | any[]

One or more arguments for the invokation.

Optional asOneArgument

asOneArgument: boolean

Submit file list as one argument or not.

Optional beforeDelete

One or more target operations that should be invoked BEFORE a deletion in that target starts.

Optional beforeDeploy

One or more target operations that should be invoked BEFORE a deployment to that target starts.

Optional beforePull

One or more target operations that should be invoked BEFORE a pullment from that target starts.

Optional checkBeforeDeploy

checkBeforeDeploy: boolean

Check for newer files before a deploy operation starts or not.

Optional checkBeforePull

checkBeforePull: boolean

Check for older files before a pull operation starts or not.

Optional cwd

cwd: string

The custom working directory to use.

Optional deleteFlag

deleteFlag: string

The optional operation flag, that indicates if files should be deleted.

Optional deleted

One or more target operations that should be invoked AFTER a deletion in that target has been done.

Optional deployFlag

deployFlag: string

The optional operation flag, that indicates if files should be deployed.

Optional deployed

One or more target operations that should be invoked AFTER a deployment to that target has been done.

Optional description

description: string

A description.

Optional dumpOutput

dumpOutput: string

Dump stdout and stderr to console or not.

Optional encryptBy

encryptBy: string

The custom password algorithm to use.

Optional encryptWith

encryptWith: string

The password.

Optional fileSeparator

fileSeparator: string

An expression that is used to concat a file list to one string.

Optional hideIf

hideIf: string | string[]

A list of one or more package names that indicates if that target is hidden from GUI if one of the package(s) has been selected.

Optional if

if: string | string[]

One or more (JavaScript) conditions that check if that item is available or not.

Optional input

input: string

The value for stdin.

Optional inputEncoding

inputEncoding: string

The encoding to use for stdin.

Optional inputIsScript

inputIsScript: boolean

'input' is the path to a script that provides the value for stdin or not.

Optional inputScriptOptions

inputScriptOptions: any

Options for the input script.

Optional isHidden

isHidden: boolean

Is hidden or not.

Optional mappings

mappings: deploy_mappings.FolderMappings

Defines folder mappings.

Optional name

name: string

The name.

Optional outDirectory

outDirectory: string

The custom output directory.

Optional pathSeparator

pathSeparator: string

The custom path separator to use.

Optional platforms

platforms: string | string[]

One or more platform names, the object is available for.

Optional prepare

Operations which are executed even before the operations of 'beforeDeploy' and even if no file is going to be handled.

Optional prependFileList

prependFileList: string

At file list at the beginning of the argument list (true) or at the end (false).

Optional pullFlag

pullFlag: string

The optional operation flag, that indicates if files should be pulled.

Optional pulled

One or more target operations that should be invoked AFTER a pullment from that target has been done.

Optional removeFoldersFlag

removeFoldersFlag: string

The optional operation flag, that indicates if folders should be removed.

Optional runInTerminal

runInTerminal: boolean

Run in integrated terminal or not.

Optional showIf

showIf: string | string[]

A list of one or more package names that indicates if that target is only shown in GUI if one of the package(s) has been selected.

Optional submitFileList

submitFileList: boolean

Submit file list or not.

Optional transformer

transformer: string

The path (or URI) to the transformer script.

Optional transformerOptions

transformerOptions: any

The options for the transformer script.

Optional type

type: string

The type.

Optional useFastGlob

useFastGlob: boolean

Use 'fast-glob' instead of 'node-glob' or not.

Optional usePlaceholders

usePlaceholders: boolean

Use placeholders in arguments or not.

Optional useRelativePaths

useRelativePaths: boolean

Use relative paths for file lists or not.

Generated using TypeDoc