Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace tasks

Namespace for tasks functionality.

Index

Functions(7)

registerTaskProvider

  • 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

  • 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

  • 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

Const onDidEndTask

Const onDidStartTaskProcess

Const onDidEndTaskProcess

Variables(1)

Const taskExecutions

taskExecutions: readonly TaskExecution[]

The currently active task executions or an empty array.

Generated by TypeDoc. Maintained by 洛竹