Liking cljdoc? Tell your friends :D

dots.vscode.task

A task to execute

A task to execute
raw docstring

background?cljs

(background? task)

Whether the task is a background task or not.

Returns: boolean

Whether the task is a background task or not.

**Returns:** `boolean`
sourceraw docstring

definitioncljs

(definition task)

The task's definition.

Returns: TaskDefinition

The task's definition.

**Returns:** `TaskDefinition`
sourceraw docstring

detailcljs

(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`
sourceraw docstring

executioncljs

(execution task)

The task's execution engine

Returns: ProcessExecution | ShellExecution | CustomExecution | undefined

The task's execution engine

**Returns:** `ProcessExecution | ShellExecution | CustomExecution | undefined`
sourceraw docstring

groupcljs

(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`
sourceraw docstring

namecljs

(name task)

The task's name

Returns: string

The task's name

**Returns:** `string`
sourceraw docstring

presentation-optionscljs

(presentation-options task)

The presentation options. Defaults to an empty literal.

Returns: TaskPresentationOptions

The presentation options. Defaults to an empty literal.

**Returns:** `TaskPresentationOptions`
sourceraw docstring

problem-matcherscljs

(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[]`
sourceraw docstring

run-optionscljs

(run-options task)

Run options for the task

Returns: RunOptions

Run options for the task

**Returns:** `RunOptions`
sourceraw docstring

scopecljs

(scope task)

The task's scope.

Returns: TaskScope | WorkspaceFolder | undefined

The task's scope.

**Returns:** `TaskScope | WorkspaceFolder | undefined`
sourceraw docstring

set-definition!cljs

(set-definition! task value)

The task's definition.

The task's definition.
sourceraw docstring

set-detail!cljs

(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.
sourceraw docstring

set-execution!cljs

(set-execution! task value)

The task's execution engine

The task's execution engine
sourceraw docstring

set-group!cljs

(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.
sourceraw docstring

set-is-background!cljs

(set-is-background! task value)

Whether the task is a background task or not.

Whether the task is a background task or not.
sourceraw docstring

set-name!cljs

(set-name! task value)

The task's name

The task's name
sourceraw docstring

set-presentation-options!cljs

(set-presentation-options! task value)

The presentation options. Defaults to an empty literal.

The presentation options. Defaults to an empty literal.
sourceraw docstring

set-problem-matchers!cljs

(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.
sourceraw docstring

set-run-options!cljs

(set-run-options! task value)

Run options for the task

Run options for the task
sourceraw docstring

set-source!cljs

(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.
sourceraw docstring

sourcecljs

(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`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close