VS Code API
    Preparing search index...

    Class Task

    A task to execute

    Index

    Constructors

    constructor

    Properties

    definition detail? execution? group? isBackground name presentationOptions problemMatchers runOptions scope source

    Constructors

    • Creates a new task.

      Parameters

      • taskDefinition: TaskDefinition

        The task definition as defined in the taskDefinitions extension point.

      • scope: WorkspaceFolder | Global | Workspace

        Specifies the task's scope. It is either a global or a workspace task or a task for a specific workspace folder. Global tasks are currently not supported.

      • name: string

        The task's name. Is presented in the user interface.

      • source: string

        The task's source (e.g. 'gulp', 'npm', ...). Is presented in the user interface.

      • Optionalexecution: ProcessExecution | ShellExecution | CustomExecution

        The process or shell execution.

      • OptionalproblemMatchers: string | string[]

        the names of problem matchers to use, like '$tsc' or '$eslint'. Problem matchers can be contributed by an extension using the problemMatchers extension point.

      Returns Task

    • Creates a new task.

      Parameters

      • taskDefinition: TaskDefinition

        The task definition as defined in the taskDefinitions extension point.

      • name: string

        The task's name. Is presented in the user interface.

      • source: string

        The task's source (e.g. 'gulp', 'npm', ...). Is presented in the user interface.

      • Optionalexecution: ProcessExecution | ShellExecution

        The process or shell execution.

      • OptionalproblemMatchers: string | string[]

        the names of problem matchers to use, like '$tsc' or '$eslint'. Problem matchers can be contributed by an extension using the problemMatchers extension point.

      Returns Task

      Use the new constructors that allow specifying a scope for the task.

    Properties

    definition: TaskDefinition

    The task's definition.

    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?: ProcessExecution | ShellExecution | CustomExecution

    The task's execution engine

    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: boolean

    Whether the task is a background task or not.

    name: string

    The task's name

    presentationOptions: TaskPresentationOptions

    The presentation options. Defaults to an empty literal.

    problemMatchers: string[]

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

    runOptions: RunOptions

    Run options for the task

    scope: WorkspaceFolder | Global | Workspace | undefined

    The task's scope.

    source: string

    A human-readable string describing the source of this shell task, e.g. 'gulp' or 'npm'. Supports rendering of theme icons via the $(<name>)-syntax.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties