Class Task

Hierarchy (view full)

Task
- Task2

Constructors

constructor

new Task(taskDefinition, scope, name, source, execution?, problemMatchers?): Task
Parameters
- taskDefinition: TaskDefinition
- scope: WorkspaceFolder | Global | Workspace
- name: string
- source: string
- Optional execution: ProcessExecution | ShellExecution | CustomExecution
- Optional problemMatchers: string | string[]
Returns Task
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2644
new Task(taskDefinition, name, source, execution?, problemMatchers?): Task
Parameters
- taskDefinition: TaskDefinition
- name: string
- source: string
- Optional execution: ProcessExecution | ShellExecution | CustomExecution
- Optional problemMatchers: string | string[]
Returns Task
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2654

Properties

`Private` hasTaskProblemMatchers

hasTaskProblemMatchers: boolean

`Private` isTaskBackground

isTaskBackground: boolean

`Private` taskDefinition

taskDefinition: TaskDefinition

`Private` taskExecution

taskExecution: undefined | ProcessExecution | ShellExecution | CustomExecution

`Private` taskGroup

taskGroup: undefined | TaskGroup

`Private` taskName

taskName: string

`Private` taskPresentationOptions

taskPresentationOptions: TaskPresentationOptions

`Private` taskProblemMatchers

taskProblemMatchers: string[]

`Private` taskRunOptions

taskRunOptions: RunOptions

`Private` taskScope

taskScope: undefined | WorkspaceFolder | Global | Workspace

`Private` taskSource

taskSource: string

Accessors

definition

get definition(): TaskDefinition
Returns TaskDefinition
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2711
set definition(value): void
Parameters
- value: TaskDefinition
Returns void
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2715

execution

get execution(): undefined | ProcessExecution | ShellExecution | CustomExecution
Returns undefined | ProcessExecution | ShellExecution | CustomExecution
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2744
set execution(value): void
Parameters
- value: undefined | ProcessExecution | ShellExecution | CustomExecution
Returns void
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2748

group

get group(): undefined | TaskGroup
Returns undefined | TaskGroup
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2795
set group(value): void
Parameters
- value: undefined | TaskGroup
Returns void
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2799

hasProblemMatchers

get hasProblemMatchers(): boolean
Returns boolean
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2769

isBackground

get isBackground(): boolean
Returns boolean
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2773
set isBackground(value): void
Parameters
- value: boolean
Returns void
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2777

name

get name(): string
Returns string
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2733
set name(value): void
Parameters
- value: string
Returns void
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2737

presentationOptions

get presentationOptions(): TaskPresentationOptions
Returns TaskPresentationOptions
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2807
set presentationOptions(value): void
Parameters
- value: TaskPresentationOptions
Returns void
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2811

problemMatchers

get problemMatchers(): string[]
Returns string[]
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2755
set problemMatchers(value): void
Parameters
- value: string[]
Returns void
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2759

runOptions

get runOptions(): RunOptions
Returns RunOptions
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2818
set runOptions(value): void
Parameters
- value: RunOptions
Returns void
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2822

scope

get scope(): undefined | WorkspaceFolder | Global | Workspace
Returns undefined | WorkspaceFolder | Global | Workspace
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2722
set scope(value): void
Parameters
- value: undefined | WorkspaceFolder | Global | Workspace
Returns void
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2726

source

get source(): string
Returns string
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2784
set source(value): void
Parameters
- value: string
Returns void
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:2788

Class Task

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Constructors

constructor

Parameters

Returns Task

Parameters

Returns Task

Properties

Private hasTaskProblemMatchers

Private isTaskBackground

Private taskDefinition

Private taskExecution

Private taskGroup

Private taskName

Private taskPresentationOptions

Private taskProblemMatchers

Private taskRunOptions

Private taskScope

Private taskSource

Accessors

definition

Returns TaskDefinition

Parameters

Returns void

execution

Returns undefined | ProcessExecution | ShellExecution | CustomExecution

Parameters

Returns void

group

Returns undefined | TaskGroup

Parameters

Returns void

hasProblemMatchers

Returns boolean

isBackground

Returns boolean

Parameters

Returns void

name

Returns string

Parameters

Returns void

presentationOptions

Returns TaskPresentationOptions

Parameters

Returns void

problemMatchers

Returns string[]

Parameters

Returns void

runOptions

Returns RunOptions

Parameters

Returns void

scope

Returns undefined | WorkspaceFolder | Global | Workspace

Parameters

Returns void

source

Returns string

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` hasTaskProblemMatchers

`Private` isTaskBackground

`Private` taskDefinition

`Private` taskExecution

`Private` taskGroup

`Private` taskName

`Private` taskPresentationOptions

`Private` taskProblemMatchers

`Private` taskRunOptions

`Private` taskScope

`Private` taskSource