API Docs for: 0.9.3
Show:

ShellTask Class

Extends AbstractTask
Defined in: lib/task/shell.js:10

Constructor

ShellTask

()

Defined in lib/task/shell.js:10

Methods

_run

(
  • parentId
)
Promise private

Inherited from AbstractTask but overwritten in lib/task/shell.js:88

Run the client

Parameters:

Returns:

Promise:

augment

()

Inherited from AbstractTask: lib/abstractTask.js:113

Augments the data with default values

getClientDecoratorPlugins

() Object[]

Inherited from AbstractTask: lib/abstractTask.js:304

Gets all client-decorator plugins

Returns:

Object[]:

getCommand

() String

Defined in lib/task/shell.js:57

Get command to execute

Returns:

String:

getConfiguration

() Object

Inherited from AbstractTask: lib/abstractTask.js:133

Gets the client configuration

Returns:

Object:

getCoverageCollector

() Collector

Inherited from AbstractTask: lib/abstractTask.js:163

Gets the coverage collector

Returns:

Collector:

getCwd

() String | Null

Defined in lib/task/shell.js:77

Get the current working directory

Returns:

String | Null:

getDecorators

() Object[]

Inherited from AbstractTask: lib/abstractTask.js:143

Gets the decorator list

Returns:

Object[]:

getEnv

() Object

Defined in lib/task/shell.js:67

Get the environment variables set for the shell

Returns:

Object:

getGlobalConfig

() Object

Inherited from AbstractTask: lib/abstractTask.js:153

Gets the global configuration

Returns:

Object:

getLabel

() String

Inherited from AbstractTask: lib/abstractTask.js:337

Gets the label of the task

Returns:

String:

getName

() String

Inherited from AbstractTask: lib/abstractTask.js:193

Gets the name of the preceptor task

Returns:

String:

getOptions

() Object

Inherited from AbstractTask: lib/abstractTask.js:123

Gets the options

Returns:

Object:

getPlugins

() Object

Inherited from AbstractTask: lib/abstractTask.js:284

Gets all plugins

Returns:

Object:

getReportManager

() ReportManager

Inherited from AbstractTask: lib/abstractTask.js:326

Gets the report manager

Returns:

ReportManager:

getTaskDecoratorPlugins

() AbstractTaskDecorator[]

Inherited from AbstractTask: lib/abstractTask.js:294

Gets all options-decorator plugins

Returns:

AbstractTaskDecorator[]:

getTaskId

() String

Inherited from AbstractTask: lib/abstractTask.js:183

Gets a unique id for the task

Returns:

String:

getTaskPlugin

(
  • name
)
AbstractTask

Inherited from AbstractTask: lib/abstractTask.js:314

Gets a specific task plugin

Parameters:

Returns:

AbstractTask:

getTitle

() String

Inherited from AbstractTask: lib/abstractTask.js:203

Gets the title of the preceptor task

Returns:

String:

getType

() String

Inherited from AbstractTask: lib/abstractTask.js:173

Gets the type of the preceptor task

Returns:

String:

inDebug

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:223

Is the task in debug-mode?

Returns:

Boolean:

initialize

()

Inherited from AbstractTask but overwritten in lib/task/shell.js:18

Initializes the instance

isActive

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:233

Is the task active?

Returns:

Boolean:

isSuite

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:213

Run tasks in a suite?

Returns:

Boolean:

isVerbose

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:243

Is the task verbose?

Returns:

Boolean:

run

(
  • parentId
)
Promise

Inherited from AbstractTask: lib/abstractTask.js:348

Run the task

Parameters:

Returns:

Promise:

shouldEchoStdErr

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:273

Echo std-err output of child-process?

Returns:

Boolean:

shouldEchoStdOut

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:263

Echo std-out output of child-process?

Returns:

Boolean:

shouldReport

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:253

Should report?

Returns:

Boolean:

validate

()

Inherited from AbstractTask but overwritten in lib/task/shell.js:37

Validates the given data