A task to execute
A task to execute
(background? task)
Whether the task is a background task or not.
Returns: boolean
Whether the task is a background task or not. **Returns:** `boolean`
(definition task)
The task's definition.
Returns: TaskDefinition
The task's definition. **Returns:** `TaskDefinition`
(detail task)
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 {@link ThemeIcon theme icons}
via the $(<name>)
-syntax.
Returns: string | undefined
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 {@link ThemeIcon theme icons} via the `$(<name>)`-syntax. **Returns:** `string | undefined`
(execution task)
The task's execution engine
Returns: ProcessExecution | ShellExecution | CustomExecution | undefined
The task's execution engine **Returns:** `ProcessExecution | ShellExecution | CustomExecution | undefined`
(group task)
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.
Returns: TaskGroup | undefined
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. **Returns:** `TaskGroup | undefined`
(name task)
The task's name
Returns: string
The task's name **Returns:** `string`
(presentation-options task)
The presentation options. Defaults to an empty literal.
Returns: TaskPresentationOptions
The presentation options. Defaults to an empty literal. **Returns:** `TaskPresentationOptions`
(problem-matchers task)
The problem matchers attached to the task. Defaults to an empty array.
Returns: string[]
The problem matchers attached to the task. Defaults to an empty array. **Returns:** `string[]`
(run-options task)
Run options for the task
Returns: RunOptions
Run options for the task **Returns:** `RunOptions`
(scope task)
The task's scope.
Returns: TaskScope | WorkspaceFolder | undefined
The task's scope. **Returns:** `TaskScope | WorkspaceFolder | undefined`
(set-definition! task value)
The task's definition.
The task's definition.
(set-detail! task value)
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 {@link ThemeIcon theme icons}
via the $(<name>)
-syntax.
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 {@link ThemeIcon theme icons} via the `$(<name>)`-syntax.
(set-execution! task value)
The task's execution engine
The task's execution engine
(set-group! task value)
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.
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.
(set-is-background! task value)
Whether the task is a background task or not.
Whether the task is a background task or not.
(set-presentation-options! task value)
The presentation options. Defaults to an empty literal.
The presentation options. Defaults to an empty literal.
(set-problem-matchers! task value)
The problem matchers attached to the task. Defaults to an empty array.
The problem matchers attached to the task. Defaults to an empty array.
(set-run-options! task value)
Run options for the task
Run options for the task
(set-source! task value)
A human-readable string describing the source of this shell task, e.g. 'gulp'
or 'npm'. Supports rendering of {@link ThemeIcon theme icons} via the $(<name>)
-syntax.
A human-readable string describing the source of this shell task, e.g. 'gulp' or 'npm'. Supports rendering of {@link ThemeIcon theme icons} via the `$(<name>)`-syntax.
(source task)
A human-readable string describing the source of this shell task, e.g. 'gulp'
or 'npm'. Supports rendering of {@link ThemeIcon theme icons} via the $(<name>)
-syntax.
Returns: string
A human-readable string describing the source of this shell task, e.g. 'gulp' or 'npm'. Supports rendering of {@link ThemeIcon theme icons} via the `$(<name>)`-syntax. **Returns:** `string`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close