Namespace tasks

Namespace for tasks functionality.

Index

Functions

Variables

taskExecutions

Functions

registerTaskProvider

registerTaskProvider(type: string, provider: TaskProvider): Disposable

- Defined in vscode.d.ts:6938
Register a task provider.

Parameters
- type: string
  
  The task kind type this provider is registered for.
- provider: TaskProvider
  
  A task provider.
Returns Disposable

A Disposable that unregisters this provider when being disposed.

fetchTasks

fetchTasks(filter?: TaskFilter): Thenable<Task[]>

- Defined in vscode.d.ts:6947
Fetches all tasks available in the systems. This includes tasks from tasks.json files as well as tasks from task providers contributed through extensions.

Parameters
- Optional filter: TaskFilter
  
  Optional filter to select tasks of a certain type or version.
Returns Thenable<Task[]>

executeTask

executeTask(task: Task): Thenable<TaskExecution>

- Defined in vscode.d.ts:6959
Executes a task that is managed by the editor. The returned task execution can be used to terminate the task.

throws

When running a ShellExecution or a ProcessExecution task in an environment where a new process cannot be started. In such an environment, only CustomExecution tasks can be run.

Parameters
- task: Task
  
  the task to execute
Returns Thenable<TaskExecution>

Const onDidStartTask

onDidStartTask(listener: (e: TaskStartEvent) => any, thisArgs?: any, disposables?: Disposable[]): Disposable

- Defined in vscode.d.ts:6969
Fires when a task starts.

Parameters
- listener: (e: TaskStartEvent) => any
  - - (e: TaskStartEvent): any
    - Parameters
      - e: TaskStartEvent
      Returns any
- Optional thisArgs: any
- Optional disposables: Disposable[]
Returns Disposable

Const onDidEndTask

onDidEndTask(listener: (e: TaskEndEvent) => any, thisArgs?: any, disposables?: Disposable[]): Disposable

- Defined in vscode.d.ts:6974
Fires when a task ends.

Parameters
- listener: (e: TaskEndEvent) => any
  - - (e: TaskEndEvent): any
    - Parameters
      - e: TaskEndEvent
      Returns any
- Optional thisArgs: any
- Optional disposables: Disposable[]
Returns Disposable

Const onDidStartTaskProcess

onDidStartTaskProcess(listener: (e: TaskProcessStartEvent) => any, thisArgs?: any, disposables?: Disposable[]): Disposable

- Defined in vscode.d.ts:6981
Fires when the underlying process has been started. This event will not fire for tasks that don't execute an underlying process.

Parameters
- listener: (e: TaskProcessStartEvent) => any
  - - (e: TaskProcessStartEvent): any
    - Parameters
      - e: TaskProcessStartEvent
      Returns any
- Optional thisArgs: any
- Optional disposables: Disposable[]
Returns Disposable

Const onDidEndTaskProcess

onDidEndTaskProcess(listener: (e: TaskProcessEndEvent) => any, thisArgs?: any, disposables?: Disposable[]): Disposable

- Defined in vscode.d.ts:6988
Fires when the underlying process has ended. This event will not fire for tasks that don't execute an underlying process.

Parameters
- listener: (e: TaskProcessEndEvent) => any
  - - (e: TaskProcessEndEvent): any
    - Parameters
      - e: TaskProcessEndEvent
      Returns any
- Optional thisArgs: any
- Optional disposables: Disposable[]
Returns Disposable

Variables

Const taskExecutions

taskExecutions: readonly TaskExecution[]

The currently active task executions or an empty array.

Generated using TypeDoc