dots.vscode.tasks

Liking cljdoc? Tell your friends :D

ClojureScript only.

execute-task
fetch-tasks
on-did-end-task
on-did-end-task-process
on-did-start-task
on-did-start-task-process
register-task-provider
task-executions

Namespace for tasks functionality.

Namespace for tasks functionality.

raw docstring

execute-task^cljs

(execute-task task)

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

Parameters:

task: Task - the task to execute

Returns: Thenable<TaskExecution> - A thenable that resolves to a task execution.

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

**Parameters:**
- `task`: `Task` - the task to execute

**Returns:** `Thenable<TaskExecution>` - A thenable that resolves to a task execution.

source raw docstring

fetch-tasks^cljs

(fetch-tasks)

(fetch-tasks filter)

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:

filter: TaskFilter | undefined - Optional filter to select tasks of a certain type or version.

Returns: Thenable<Task[]> - A thenable that resolves to an array of tasks.

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:**
- `filter`: `TaskFilter | undefined` - Optional filter to select tasks of a certain type or version.

**Returns:** `Thenable<Task[]>` - A thenable that resolves to an array of tasks.

source raw docstring

on-did-end-task^cljs

(on-did-end-task)

(on-did-end-task listener)

(on-did-end-task listener this-args)

(on-did-end-task listener this-args disposables)

Fires when a task ends.

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

Fires when a task ends.

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

on-did-end-task-process^cljs

(on-did-end-task-process)

(on-did-end-task-process listener)

(on-did-end-task-process listener this-args)

(on-did-end-task-process listener this-args disposables)

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

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

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

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

on-did-start-task^cljs

(on-did-start-task)

(on-did-start-task listener)

(on-did-start-task listener this-args)

(on-did-start-task listener this-args disposables)

Fires when a task starts.

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

Fires when a task starts.

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

on-did-start-task-process^cljs

(on-did-start-task-process)

(on-did-start-task-process listener)

(on-did-start-task-process listener this-args)

(on-did-start-task-process listener this-args disposables)

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

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

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

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

register-task-provider^cljs

(register-task-provider type provider)

Parameters:

type: string - The task kind type this provider is registered for.
provider: TaskProvider<Task> - A task provider.

Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.

Register a task provider.

**Parameters:**
- `type`: `string` - The task kind type this provider is registered for.
- `provider`: `TaskProvider<Task>` - A task provider.

**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.

source raw docstring

task-executions^cljs

(task-executions)

The currently active task executions or an empty array.

Returns: readonly TaskExecution[]

The currently active task executions or an empty array.

**Returns:** `readonly TaskExecution[]`

source raw docstring

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

Keyboard shortcuts Report a problem cljdoc on GitHub

× close