|
|
<!doctype html>
|
|
|
<html class="default no-js">
|
|
|
<head>
|
|
|
<meta charset="utf-8">
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
<title>Task | VS Code API 中文文档</title>
|
|
|
<meta name="description" content="VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API。这个站点列出了扩展开发者可以使用的所有 vscode api 中文文档。">
|
|
|
<meta property="og:site_name" content="Vscode Api 中文文档">
|
|
|
<meta property="og:type" content="docs">
|
|
|
<meta property="og:url" content="https://vscode-api-cn.js.org/index.html">
|
|
|
<meta property="article:tag" content="vscode">
|
|
|
<meta property="article:tag" content="vscode api">
|
|
|
<meta property="article:tag" content="vscode api 中文文档">
|
|
|
<meta property="article:tag" content="vscode api 文档">
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
<link rel="shortcut icon" href="https://code.visualstudio.com/favicon.ico" sizes="128x128">
|
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
|
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-7962287588031867" crossorigin="anonymous"></script>
|
|
|
<script type="text/javascript">
|
|
|
(function (c, l, a, r, i, t, y) {
|
|
|
c[a] = c[a] || function () { (c[a].q = c[a].q || []).push(arguments) };
|
|
|
t = l.createElement(r); t.async = 1; t.src = "https://www.clarity.ms/tag/" + i;
|
|
|
y = l.getElementsByTagName(r)[0]; y.parentNode.insertBefore(t, y);
|
|
|
})(window, document, "clarity", "script", "g1cbw4nxoq");
|
|
|
</script>
|
|
|
<!-- Google tag (gtag.js) -->
|
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-T4TRRS1LB1"></script>
|
|
|
<script>
|
|
|
window.dataLayer = window.dataLayer || [];
|
|
|
function gtag(){dataLayer.push(arguments);}
|
|
|
gtag('js', new Date());
|
|
|
|
|
|
gtag('config', 'G-T4TRRS1LB1');
|
|
|
</script>
|
|
|
<style>
|
|
|
.github-corner svg {
|
|
|
z-index: 1;
|
|
|
}
|
|
|
.github-corner:hover .octo-arm {
|
|
|
animation:octocat-wave 560ms ease-in-out
|
|
|
}
|
|
|
@keyframes octocat-wave {
|
|
|
0%,100%{transform:rotate(0)}
|
|
|
20%,60%{transform:rotate(-25deg)}
|
|
|
40%,80%{transform:rotate(10deg)}
|
|
|
}
|
|
|
@media (max-width:500px) {
|
|
|
.github-corner:hover
|
|
|
.octo-arm{animation:none}
|
|
|
.github-corner .octo-arm{
|
|
|
animation:octocat-wave 560ms ease-in-out
|
|
|
}
|
|
|
}
|
|
|
.container-main {
|
|
|
padding-bottom: 50px;
|
|
|
}
|
|
|
</style>
|
|
|
</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="../modules/vscode.html">vscode</a>
|
|
|
</li>
|
|
|
<li>
|
|
|
<a href="vscode.Task.html">Task</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h1>Class Task</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>A task to execute</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
|
<h3>层级</h3>
|
|
|
<ul class="tsd-hierarchy">
|
|
|
<li>
|
|
|
<span class="target">Task</span>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</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>Constructors（1）</h3>
|
|
|
<ul class="tsd-index-list">
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="vscode.Task.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-index-section ">
|
|
|
<h3>Properties（11）</h3>
|
|
|
<ul class="tsd-index-list">
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Task.html#definition" class="tsd-kind-icon">definition</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Task.html#scope" class="tsd-kind-icon">scope</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Task.html#name" class="tsd-kind-icon">name</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Task.html#detail" class="tsd-kind-icon">detail</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Task.html#execution" class="tsd-kind-icon">execution</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Task.html#isBackground" class="tsd-kind-icon">is<wbr>Background</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Task.html#source" class="tsd-kind-icon">source</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Task.html#group" class="tsd-kind-icon">group</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Task.html#presentationOptions" class="tsd-kind-icon">presentation<wbr>Options</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Task.html#problemMatchers" class="tsd-kind-icon">problem<wbr>Matchers</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Task.html#runOptions" class="tsd-kind-icon">run<wbr>Options</a></li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
</div>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
<h2>Constructors（1）</h2>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
|
<h3>constructor</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Task<span class="tsd-signature-symbol">(</span>taskDefinition<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.TaskDefinition.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskDefinition</a>, scope<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.WorkspaceFolder.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceFolder</a><span class="tsd-signature-symbol"> | </span><a href="../enums/vscode.TaskScope.html#Global" class="tsd-signature-type" data-tsd-kind="Enumeration member">Global</a><span class="tsd-signature-symbol"> | </span><a href="../enums/vscode.TaskScope.html#Workspace" class="tsd-signature-type" data-tsd-kind="Enumeration member">Workspace</a>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, execution<span class="tsd-signature-symbol">?: </span><a href="vscode.ProcessExecution.html" class="tsd-signature-type" data-tsd-kind="Class">ProcessExecution</a><span class="tsd-signature-symbol"> | </span><a href="vscode.ShellExecution.html" class="tsd-signature-type" data-tsd-kind="Class">ShellExecution</a><span class="tsd-signature-symbol"> | </span><a href="vscode.CustomExecution.html" class="tsd-signature-type" data-tsd-kind="Class">CustomExecution</a>, problemMatchers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.Task.html" class="tsd-signature-type" data-tsd-kind="Class">Task</a></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Task<span class="tsd-signature-symbol">(</span>taskDefinition<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.TaskDefinition.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskDefinition</a>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, execution<span class="tsd-signature-symbol">?: </span><a href="vscode.ProcessExecution.html" class="tsd-signature-type" data-tsd-kind="Class">ProcessExecution</a><span class="tsd-signature-symbol"> | </span><a href="vscode.ShellExecution.html" class="tsd-signature-type" data-tsd-kind="Class">ShellExecution</a>, problemMatchers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.Task.html" class="tsd-signature-type" data-tsd-kind="Class">Task</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/201e4fb/vscode.d.ts#L6740">vscode.d.ts:6740</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Creates a new task.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>taskDefinition: <a href="../interfaces/vscode.TaskDefinition.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskDefinition</a></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>scope: <a href="../interfaces/vscode.WorkspaceFolder.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceFolder</a><span class="tsd-signature-symbol"> | </span><a href="../enums/vscode.TaskScope.html#Global" class="tsd-signature-type" data-tsd-kind="Enumeration member">Global</a><span class="tsd-signature-symbol"> | </span><a href="../enums/vscode.TaskScope.html#Workspace" class="tsd-signature-type" data-tsd-kind="Enumeration member">Workspace</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>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.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The task's name. Is presented in the user interface.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>source: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The task's source (e.g. 'gulp', 'npm', ...). Is presented in the user interface.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> execution: <a href="vscode.ProcessExecution.html" class="tsd-signature-type" data-tsd-kind="Class">ProcessExecution</a><span class="tsd-signature-symbol"> | </span><a href="vscode.ShellExecution.html" class="tsd-signature-type" data-tsd-kind="Class">ShellExecution</a><span class="tsd-signature-symbol"> | </span><a href="vscode.CustomExecution.html" class="tsd-signature-type" data-tsd-kind="Class">CustomExecution</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The process or shell execution.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> problemMatchers: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>the names of problem matchers to use, like '$tsc'
|
|
|
or '$eslint'. Problem matchers can be contributed by an extension using
|
|
|
the <code>problemMatchers</code> extension point.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.Task.html" class="tsd-signature-type" data-tsd-kind="Class">Task</a></h4>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/201e4fb/vscode.d.ts#L6755">vscode.d.ts:6755</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Creates a new task.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>deprecated</dt>
|
|
|
<dd><p>Use the new constructors that allow specifying a scope for the task.</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>taskDefinition: <a href="../interfaces/vscode.TaskDefinition.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskDefinition</a></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The task's name. Is presented in the user interface.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>source: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The task's source (e.g. 'gulp', 'npm', ...). Is presented in the user interface.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> execution: <a href="vscode.ProcessExecution.html" class="tsd-signature-type" data-tsd-kind="Class">ProcessExecution</a><span class="tsd-signature-symbol"> | </span><a href="vscode.ShellExecution.html" class="tsd-signature-type" data-tsd-kind="Class">ShellExecution</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The process or shell execution.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> problemMatchers: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>the names of problem matchers to use, like '$tsc'
|
|
|
or '$eslint'. Problem matchers can be contributed by an extension using
|
|
|
the <code>problemMatchers</code> extension point.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.Task.html" class="tsd-signature-type" data-tsd-kind="Class">Task</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
<h2>Properties（11）</h2>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="definition" class="tsd-anchor"></a>
|
|
|
<h3>definition</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">definition<span class="tsd-signature-symbol">:</span> <a href="../interfaces/vscode.TaskDefinition.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskDefinition</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/201e4fb/vscode.d.ts#L6760">vscode.d.ts:6760</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The task's definition.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="scope" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> scope</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">scope<span class="tsd-signature-symbol">:</span> <a href="../interfaces/vscode.WorkspaceFolder.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceFolder</a><span class="tsd-signature-symbol"> | </span><a href="../enums/vscode.TaskScope.html#Global" class="tsd-signature-type" data-tsd-kind="Enumeration member">Global</a><span class="tsd-signature-symbol"> | </span><a href="../enums/vscode.TaskScope.html#Workspace" class="tsd-signature-type" data-tsd-kind="Enumeration member">Workspace</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/201e4fb/vscode.d.ts#L6765">vscode.d.ts:6765</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The task's scope.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="name" class="tsd-anchor"></a>
|
|
|
<h3>name</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/201e4fb/vscode.d.ts#L6770">vscode.d.ts:6770</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The task's name</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="detail" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> detail</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">detail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/201e4fb/vscode.d.ts#L6777">vscode.d.ts:6777</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>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 <a href="vscode.ThemeIcon.html">theme icons</a>
|
|
|
via the <code>$(<name>)</code>-syntax.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="execution" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> execution</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">execution<span class="tsd-signature-symbol">:</span> <a href="vscode.ProcessExecution.html" class="tsd-signature-type" data-tsd-kind="Class">ProcessExecution</a><span class="tsd-signature-symbol"> | </span><a href="vscode.ShellExecution.html" class="tsd-signature-type" data-tsd-kind="Class">ShellExecution</a><span class="tsd-signature-symbol"> | </span><a href="vscode.CustomExecution.html" class="tsd-signature-type" data-tsd-kind="Class">CustomExecution</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/201e4fb/vscode.d.ts#L6782">vscode.d.ts:6782</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The task's execution engine</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="isBackground" class="tsd-anchor"></a>
|
|
|
<h3>is<wbr>Background</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">is<wbr>Background<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/201e4fb/vscode.d.ts#L6787">vscode.d.ts:6787</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Whether the task is a background task or not.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="source" class="tsd-anchor"></a>
|
|
|
<h3>source</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/201e4fb/vscode.d.ts#L6793">vscode.d.ts:6793</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A human-readable string describing the source of this shell task, e.g. 'gulp'
|
|
|
or 'npm'. Supports rendering of <a href="vscode.ThemeIcon.html">theme icons</a> via the <code>$(<name>)</code>-syntax.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="group" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> group</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">group<span class="tsd-signature-symbol">:</span> <a href="vscode.TaskGroup.html" class="tsd-signature-type" data-tsd-kind="Class">TaskGroup</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/201e4fb/vscode.d.ts#L6801">vscode.d.ts:6801</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>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.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="presentationOptions" class="tsd-anchor"></a>
|
|
|
<h3>presentation<wbr>Options</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">presentation<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/vscode.TaskPresentationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TaskPresentationOptions</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/201e4fb/vscode.d.ts#L6806">vscode.d.ts:6806</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The presentation options. Defaults to an empty literal.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="problemMatchers" class="tsd-anchor"></a>
|
|
|
<h3>problem<wbr>Matchers</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">problem<wbr>Matchers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/201e4fb/vscode.d.ts#L6812">vscode.d.ts:6812</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The problem matchers attached to the task. Defaults to an empty
|
|
|
array.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="runOptions" class="tsd-anchor"></a>
|
|
|
<h3>run<wbr>Options</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">run<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/vscode.RunOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RunOptions</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/201e4fb/vscode.d.ts#L6817">vscode.d.ts:6817</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Run options for the task</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="current tsd-kind-namespace">
|
|
|
<a href="../modules/vscode.html">vscode</a>
|
|
|
<ul>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.authentication.html">authentication</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.commands.html">commands</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.comments.html">comments</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.debug.html">debug</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.env.html">env</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.extensions.html">extensions</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.languages.html">languages</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.notebooks.html">notebooks</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.scm.html">scm</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.tasks.html">tasks</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.tests.html">tests</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.window.html">window</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.workspace.html">workspace</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</nav>
|
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
|
<div style="width: 200px">
|
|
|
<script type="text/javascript" id="clstr_globe" src="//clustrmaps.com/globe.js?d=cMnk-gSDNcAzNMMm67U8rWRaHnjUc0Xb0giSGndepK4"></script>
|
|
|
</div>
|
|
|
<ul class="before-current">
|
|
|
</ul>
|
|
|
<ul class="current">
|
|
|
<li class="current tsd-kind-class tsd-parent-kind-namespace">
|
|
|
<a href="vscode.Task.html" class="tsd-kind-icon">Task</a>
|
|
|
<ul>
|
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
|
<a href="vscode.Task.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Task.html#definition" class="tsd-kind-icon">definition</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Task.html#scope" class="tsd-kind-icon">scope</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Task.html#name" class="tsd-kind-icon">name</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Task.html#detail" class="tsd-kind-icon">detail</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Task.html#execution" class="tsd-kind-icon">execution</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Task.html#isBackground" class="tsd-kind-icon">is<wbr>Background</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Task.html#source" class="tsd-kind-icon">source</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Task.html#group" class="tsd-kind-icon">group</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Task.html#presentationOptions" class="tsd-kind-icon">presentation<wbr>Options</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Task.html#problemMatchers" class="tsd-kind-icon">problem<wbr>Matchers</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Task.html#runOptions" class="tsd-kind-icon">run<wbr>Options</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<ul class="after-current">
|
|
|
</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>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
|
|
</footer>
|
|
|
<div class="container tsd-generator">
|
|
|
<p><a href="https://liiked.github.io/VS-Code-Extension-Doc-ZH/" target="_blank">VS Code 插件开发中文文档</a> | <a href="https://jeasonstudio.gitbooks.io/vscode-cn-doc/content/" target="_blank">VS Code 中文文档</a> | <a href="https://code.visualstudio.com/docs" target="_blank">VS Code 官网文档</a> | <a href="https://marketplace.visualstudio.com/" target="_blank">VS Code 扩展市场</a></p>
|
|
|
<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>
|
|
|
<a href="https://github.com/youngjuning/vscode-api-cn" target="_blank" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: fixed; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>
|
|
|
</body>
|
|
|
</html> |
