kotlin-vscode/vscode/tasks

tasks

object tasks(source)

Namespace for tasks functionality.

Online Documentation

Properties

Link copied to clipboard
val onDidEndTask: Event<TaskEndEvent>

Fires when a task ends.

Link copied to clipboard
val onDidEndTaskProcess: Event<TaskProcessEndEvent>

Fires when the underlying process has ended. This event will not fire for tasks that don't execute an underlying process.

Link copied to clipboard
val onDidStartTask: Event<TaskStartEvent>

Fires when a task starts.

Link copied to clipboard
val onDidStartTaskProcess: Event<TaskProcessStartEvent>

Fires when the underlying process has been started. This event will not fire for tasks that don't execute an underlying process.

Link copied to clipboard
val taskExecutions: ReadonlyArray<TaskExecution>

The currently active task executions or an empty array.

Functions

Link copied to clipboard
fun executeTask(task: Task): PromiseLike<TaskExecution>

Executes a task that is managed by the editor. The returned task execution can be used to terminate the task.

Link copied to clipboard
fun fetchTasks(filter: TaskFilter = definedExternally): PromiseLike<ReadonlyArray<Task>>

Fetches all tasks available in the systems. This includes tasks from tasks.json files as well as tasks from task providers contributed through extensions.

Link copied to clipboard
fun registerTaskProvider(type: String, provider: TaskProvider<*>): Disposable

Register a task provider.