Task

A task to execute

Constructors

constructor(taskDefinition: TaskDefinition, scope: WorkspaceFolder, name: String, source: String, execution: ProcessExecution = definedExternally, problemMatchers: String = definedExternally)

Creates a new task.

constructor(taskDefinition: TaskDefinition, scope: TaskScope, name: String, source: String, execution: ProcessExecution = definedExternally, problemMatchers: String = definedExternally)

constructor(taskDefinition: TaskDefinition, scope: WorkspaceFolder, name: String, source: String, execution: ProcessExecution = definedExternally, problemMatchers: ReadonlyArray<JsString>)

constructor(taskDefinition: TaskDefinition, scope: TaskScope, name: String, source: String, execution: ProcessExecution = definedExternally, problemMatchers: ReadonlyArray<JsString>)

constructor(taskDefinition: TaskDefinition, scope: WorkspaceFolder, name: String, source: String, execution: ShellExecution, problemMatchers: String = definedExternally)

constructor(taskDefinition: TaskDefinition, scope: TaskScope, name: String, source: String, execution: ShellExecution, problemMatchers: String = definedExternally)

constructor(taskDefinition: TaskDefinition, scope: WorkspaceFolder, name: String, source: String, execution: ShellExecution, problemMatchers: ReadonlyArray<JsString>)

constructor(taskDefinition: TaskDefinition, scope: TaskScope, name: String, source: String, execution: ShellExecution, problemMatchers: ReadonlyArray<JsString>)

constructor(taskDefinition: TaskDefinition, scope: WorkspaceFolder, name: String, source: String, execution: CustomExecution, problemMatchers: String = definedExternally)

constructor(taskDefinition: TaskDefinition, scope: TaskScope, name: String, source: String, execution: CustomExecution, problemMatchers: String = definedExternally)

constructor(taskDefinition: TaskDefinition, scope: WorkspaceFolder, name: String, source: String, execution: CustomExecution, problemMatchers: ReadonlyArray<JsString>)

constructor(taskDefinition: TaskDefinition, scope: TaskScope, name: String, source: String, execution: CustomExecution, problemMatchers: ReadonlyArray<JsString>)

Properties

definition

var definition: TaskDefinition

The task's definition.

detail

var detail: String?

A human-readable string which is rendered less prominently on a separate line in places where the task's name is displayed. Supports rendering of theme icons via the $(<name>)-syntax.

execution

var execution: JsAny?

The task's execution engine

group

var group: TaskGroup?

The task group this tasks belongs to. See TaskGroup for a predefined set of available groups. Defaults to undefined meaning that the task doesn't belong to any special group.

isBackground

var isBackground: Boolean

Whether the task is a background task or not.

name

var name: String

The task's name

presentationOptions

var presentationOptions: TaskPresentationOptions

The presentation options. Defaults to an empty literal.

problemMatchers

var problemMatchers: ReadonlyArray<JsString>

The problem matchers attached to the task. Defaults to an empty array.