|
|
|
|
|
<!doctype html>
|
|
|
|
|
|
<html class="default no-js">
|
|
|
|
|
|
<head>
|
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
|
|
|
<title>SnippetString | 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-4070818774984451" crossorigin="anonymous"></script>
|
|
|
|
|
|
<meta name="monetag" content="eb1e3d5247d1754d0fd449f7b99b110d">
|
|
|
|
|
|
<meta name="a.validate.02" content="FfmmKD6EanKVetA49MTlFFi-untsfhnAgRiw" />
|
|
|
|
|
|
<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>
|
|
|
|
|
|
.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.SnippetString.html">SnippetString</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h1>Class SnippetString</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 snippet string is a template which allows to insert text
|
|
|
|
|
|
and to control the editor cursor when insertion happens.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<p>A snippet can define tab stops and placeholders with <code>$1</code>, <code>$2</code>
|
|
|
|
|
|
and <code>${3:foo}</code>. <code>$0</code> defines the final tab stop, it defaults to
|
|
|
|
|
|
the end of the snippet. Variables are defined with <code>$name</code> and
|
|
|
|
|
|
<code>${name:default value}</code>. The full snippet syntax is documented
|
|
|
|
|
|
<a href="https://code.visualstudio.com/docs/editor/userdefinedsnippets#_creating-your-own-snippets">here</a>.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
|
|
|
|
<h3>层级</h3>
|
|
|
|
|
|
<ul class="tsd-hierarchy">
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<span class="target">SnippetString</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.SnippetString.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="tsd-index-section ">
|
|
|
|
|
|
<h3>Properties（1）</h3>
|
|
|
|
|
|
<ul class="tsd-index-list">
|
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.SnippetString.html#value" class="tsd-kind-icon">value</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="tsd-index-section ">
|
|
|
|
|
|
<h3>Methods（5）</h3>
|
|
|
|
|
|
<ul class="tsd-index-list">
|
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.SnippetString.html#appendText" class="tsd-kind-icon">append<wbr>Text</a></li>
|
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.SnippetString.html#appendTabstop" class="tsd-kind-icon">append<wbr>Tabstop</a></li>
|
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.SnippetString.html#appendPlaceholder" class="tsd-kind-icon">append<wbr>Placeholder</a></li>
|
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.SnippetString.html#appendChoice" class="tsd-kind-icon">append<wbr>Choice</a></li>
|
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.SnippetString.html#appendVariable" class="tsd-kind-icon">append<wbr>Variable</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>Snippet<wbr>String<span class="tsd-signature-symbol">(</span>value<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><a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</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/2404697/vscode.d.ts#L3382">vscode.d.ts:3382</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> value: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a></h4>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
|
|
|
<h2>Properties（1）</h2>
|
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
|
|
|
<a name="value" class="tsd-anchor"></a>
|
|
|
|
|
|
<h3>value</h3>
|
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">value<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/youngjuning/vscode-api-cn/blob/2404697/vscode.d.ts#L3380">vscode.d.ts:3380</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<div class="lead">
|
|
|
|
|
|
<p>The snippet string.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
|
|
|
<h2>Methods（5）</h2>
|
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<a name="appendText" class="tsd-anchor"></a>
|
|
|
|
|
|
<h3>append<wbr>Text</h3>
|
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">append<wbr>Text<span class="tsd-signature-symbol">(</span>string<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><a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</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/2404697/vscode.d.ts#L3391">vscode.d.ts:3391</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<div class="lead">
|
|
|
|
|
|
<p>Builder-function that appends the given string to
|
|
|
|
|
|
the <a href="vscode.SnippetString.html#value"><code>value</code></a> of this snippet string.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5>string: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<p>A value to append 'as given'. The string will be escaped.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a></h4>
|
|
|
|
|
|
<p>This snippet string.</p>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<a name="appendTabstop" class="tsd-anchor"></a>
|
|
|
|
|
|
<h3>append<wbr>Tabstop</h3>
|
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">append<wbr>Tabstop<span class="tsd-signature-symbol">(</span>number<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</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/2404697/vscode.d.ts#L3401">vscode.d.ts:3401</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<div class="lead">
|
|
|
|
|
|
<p>Builder-function that appends a tabstop (<code>$1</code>, <code>$2</code> etc) to
|
|
|
|
|
|
the <a href="vscode.SnippetString.html#value"><code>value</code></a> of this snippet string.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> number: <span class="tsd-signature-type">number</span></h5>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<p>The number of this tabstop, defaults to an auto-increment
|
|
|
|
|
|
value starting at 1.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a></h4>
|
|
|
|
|
|
<p>This snippet string.</p>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<a name="appendPlaceholder" class="tsd-anchor"></a>
|
|
|
|
|
|
<h3>append<wbr>Placeholder</h3>
|
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">append<wbr>Placeholder<span class="tsd-signature-symbol">(</span>value<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>snippet<span class="tsd-signature-symbol">: </span><a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span>, number<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</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/2404697/vscode.d.ts#L3413">vscode.d.ts:3413</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<div class="lead">
|
|
|
|
|
|
<p>Builder-function that appends a placeholder (<code>${1:value}</code>) to
|
|
|
|
|
|
the <a href="vscode.SnippetString.html#value"><code>value</code></a> of this snippet string.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5>value: <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>snippet<span class="tsd-signature-symbol">: </span><a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></h5>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<p>The value of this placeholder - either a string or a function
|
|
|
|
|
|
with which a nested snippet can be created.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> number: <span class="tsd-signature-type">number</span></h5>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<p>The number of this tabstop, defaults to an auto-increment
|
|
|
|
|
|
value starting at 1.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a></h4>
|
|
|
|
|
|
<p>This snippet string.</p>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<a name="appendChoice" class="tsd-anchor"></a>
|
|
|
|
|
|
<h3>append<wbr>Choice</h3>
|
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">append<wbr>Choice<span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, number<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</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/2404697/vscode.d.ts#L3424">vscode.d.ts:3424</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<div class="lead">
|
|
|
|
|
|
<p>Builder-function that appends a choice (<code>${1|a,b,c|}</code>) to
|
|
|
|
|
|
the <a href="vscode.SnippetString.html#value"><code>value</code></a> of this snippet string.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5>values: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<p>The values for choices - the array of strings</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> number: <span class="tsd-signature-type">number</span></h5>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<p>The number of this tabstop, defaults to an auto-increment
|
|
|
|
|
|
value starting at 1.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a></h4>
|
|
|
|
|
|
<p>This snippet string.</p>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<a name="appendVariable" class="tsd-anchor"></a>
|
|
|
|
|
|
<h3>append<wbr>Variable</h3>
|
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">append<wbr>Variable<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, defaultValue<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>snippet<span class="tsd-signature-symbol">: </span><a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</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/2404697/vscode.d.ts#L3435">vscode.d.ts:3435</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<div class="lead">
|
|
|
|
|
|
<p>Builder-function that appends a variable (<code>${VAR}</code>) to
|
|
|
|
|
|
the <a href="vscode.SnippetString.html#value"><code>value</code></a> of this snippet string.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<p>The name of the variable - excluding the <code>$</code>.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<h5>defaultValue: <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>snippet<span class="tsd-signature-symbol">: </span><a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></h5>
|
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
|
<p>The default value which is used when the variable name cannot
|
|
|
|
|
|
be resolved - either a string or a function with which a nested snippet can be created.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a></h4>
|
|
|
|
|
|
<p>This snippet string.</p>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</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.SnippetString.html" class="tsd-kind-icon">Snippet<wbr>String</a>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
|
|
|
|
<a href="vscode.SnippetString.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
|
|
|
<a href="vscode.SnippetString.html#value" class="tsd-kind-icon">value</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<a href="vscode.SnippetString.html#appendText" class="tsd-kind-icon">append<wbr>Text</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<a href="vscode.SnippetString.html#appendTabstop" class="tsd-kind-icon">append<wbr>Tabstop</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<a href="vscode.SnippetString.html#appendPlaceholder" class="tsd-kind-icon">append<wbr>Placeholder</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<a href="vscode.SnippetString.html#appendChoice" class="tsd-kind-icon">append<wbr>Choice</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
|
|
|
|
<a href="vscode.SnippetString.html#appendVariable" class="tsd-kind-icon">append<wbr>Variable</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>
|
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</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>
|
|
|
|
|
|
<script>(function (d, z, s) { s.src = 'https://' + d + '/400/' + z; try { (document.body || document.documentElement).appendChild(s) } catch (e) { } })('offfurreton.com', 5772070, document.createElement('script'))</script>
|
|
|
|
|
|
<script data-cfasync="false" type="text/javascript" src="//predictiondisplay.com/a/display.php?r=6814154"></script>
|
|
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
