You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
552 lines
32 KiB
552 lines
32 KiB
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>tasks | VS Code API 中文文档</title>
|
|
<meta name="description" content="Documentation for VS Code API 中文文档">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">VS Code API 中文文档</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../modules.html">VS Code API 中文文档</a>
|
|
</li>
|
|
<li>
|
|
<a href="tasks.html">tasks</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Namespace tasks</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Namespace for tasks functionality.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>索引</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Functions</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="tasks.html#registerTaskProvider" class="tsd-kind-icon">register<wbr>Task<wbr>Provider</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="tasks.html#fetchTasks" class="tsd-kind-icon">fetch<wbr>Tasks</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="tasks.html#executeTask" class="tsd-kind-icon">execute<wbr>Task</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="tasks.html#onDidStartTask" class="tsd-kind-icon">on<wbr>Did<wbr>Start<wbr>Task</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="tasks.html#onDidEndTask" class="tsd-kind-icon">on<wbr>Did<wbr>End<wbr>Task</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="tasks.html#onDidStartTaskProcess" class="tsd-kind-icon">on<wbr>Did<wbr>Start<wbr>Task<wbr>Process</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="tasks.html#onDidEndTaskProcess" class="tsd-kind-icon">on<wbr>Did<wbr>End<wbr>Task<wbr>Process</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Variables</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="tasks.html#taskExecutions" class="tsd-kind-icon">task<wbr>Executions</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Functions</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
<a name="registerTaskProvider" class="tsd-anchor"></a>
|
|
<h3>register<wbr>Task<wbr>Provider</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Task<wbr>Provider<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskProvider</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/39c3361/vscode.d.ts#L6938">vscode.d.ts:6938</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Register a task provider.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The task kind type this provider is registered for.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>provider: <a href="../interfaces/TaskProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskProvider</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A task provider.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
<p>A <a href="../classes/Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
<a name="fetchTasks" class="tsd-anchor"></a>
|
|
<h3>fetch<wbr>Tasks</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
<li class="tsd-signature tsd-kind-icon">fetch<wbr>Tasks<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">?: </span><a href="../interfaces/TaskFilter.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskFilter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../classes/Task.html" class="tsd-signature-type" data-tsd-kind="Class">Task</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/39c3361/vscode.d.ts#L6947">vscode.d.ts:6947</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Fetches all tasks available in the systems. This includes tasks
|
|
from <code>tasks.json</code> files as well as tasks from task providers
|
|
contributed through extensions.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> filter: <a href="../interfaces/TaskFilter.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskFilter</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Optional filter to select tasks of a certain type or version.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../classes/Task.html" class="tsd-signature-type" data-tsd-kind="Class">Task</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
<a name="executeTask" class="tsd-anchor"></a>
|
|
<h3>execute<wbr>Task</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
<li class="tsd-signature tsd-kind-icon">execute<wbr>Task<span class="tsd-signature-symbol">(</span>task<span class="tsd-signature-symbol">: </span><a href="../classes/Task.html" class="tsd-signature-type" data-tsd-kind="Class">Task</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TaskExecution.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskExecution</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/39c3361/vscode.d.ts#L6959">vscode.d.ts:6959</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Executes a task that is managed by the editor. The returned
|
|
task execution can be used to terminate the task.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>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.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>task: <a href="../classes/Task.html" class="tsd-signature-type" data-tsd-kind="Class">Task</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the task to execute</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TaskExecution.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskExecution</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
<a name="onDidStartTask" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Start<wbr>Task</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Start<wbr>Task<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskStartEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskStartEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/39c3361/vscode.d.ts#L6969">vscode.d.ts:6969</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Fires when a task starts.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskStartEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskStartEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskStartEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskStartEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>e: <a href="../interfaces/TaskStartEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskStartEvent</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
<a name="onDidEndTask" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>End<wbr>Task</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>End<wbr>Task<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskEndEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskEndEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/39c3361/vscode.d.ts#L6974">vscode.d.ts:6974</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Fires when a task ends.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskEndEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskEndEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskEndEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskEndEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>e: <a href="../interfaces/TaskEndEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskEndEvent</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
<a name="onDidStartTaskProcess" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Start<wbr>Task<wbr>Process</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Start<wbr>Task<wbr>Process<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskProcessStartEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskProcessStartEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/39c3361/vscode.d.ts#L6981">vscode.d.ts:6981</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Fires when the underlying process has been started.
|
|
This event will not fire for tasks that don't
|
|
execute an underlying process.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskProcessStartEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskProcessStartEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskProcessStartEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskProcessStartEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>e: <a href="../interfaces/TaskProcessStartEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskProcessStartEvent</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
<a name="onDidEndTaskProcess" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>End<wbr>Task<wbr>Process</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>End<wbr>Task<wbr>Process<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskProcessEndEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskProcessEndEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/39c3361/vscode.d.ts#L6988">vscode.d.ts:6988</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Fires when the underlying process has ended.
|
|
This event will not fire for tasks that don't
|
|
execute an underlying process.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskProcessEndEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskProcessEndEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskProcessEndEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskProcessEndEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>e: <a href="../interfaces/TaskProcessEndEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskProcessEndEvent</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Variables</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
|
<a name="taskExecutions" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> task<wbr>Executions</h3>
|
|
<div class="tsd-signature tsd-kind-icon">task<wbr>Executions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><a href="../interfaces/TaskExecution.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskExecution</a><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/39c3361/vscode.d.ts#L6964">vscode.d.ts:6964</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The currently active task executions or an empty array.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Exports</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="authentication.html">authentication</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="commands.html">commands</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="comments.html">comments</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="debug.html">debug</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="env.html">env</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="extensions.html">extensions</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="languages.html">languages</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="notebooks.html">notebooks</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="scm.html">scm</a>
|
|
</li>
|
|
<li class="current tsd-kind-namespace">
|
|
<a href="tasks.html">tasks</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="tests.html">tests</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="window.html">window</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="workspace.html">workspace</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="tasks.html#registerTaskProvider" class="tsd-kind-icon">register<wbr>Task<wbr>Provider</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="tasks.html#fetchTasks" class="tsd-kind-icon">fetch<wbr>Tasks</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="tasks.html#executeTask" class="tsd-kind-icon">execute<wbr>Task</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
|
<a href="tasks.html#taskExecutions" class="tsd-kind-icon">task<wbr>Executions</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="tasks.html#onDidStartTask" class="tsd-kind-icon">on<wbr>Did<wbr>Start<wbr>Task</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="tasks.html#onDidEndTask" class="tsd-kind-icon">on<wbr>Did<wbr>End<wbr>Task</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="tasks.html#onDidStartTaskProcess" class="tsd-kind-icon">on<wbr>Did<wbr>Start<wbr>Task<wbr>Process</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="tasks.html#onDidEndTaskProcess" class="tsd-kind-icon">on<wbr>Did<wbr>End<wbr>Task<wbr>Process</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>图例</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated by <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |