yetao
/
vscode-api-cn.js
mirror of https://github.com/youngjuning/vscode-api-cn.js.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
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.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '1184a7aedc'
${ noResults }
vscode-api-cn.js/classes/SnippetString.html

429 lines
22 KiB
Raw Blame History

<!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="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="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>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">SnippetString</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="SnippetString.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="SnippetString.html#value" class="tsd-kind-icon">value</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SnippetString.html#appendText" class="tsd-kind-icon">append<wbr>Text</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SnippetString.html#appendTabstop" class="tsd-kind-icon">append<wbr>Tabstop</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SnippetString.html#appendPlaceholder" class="tsd-kind-icon">append<wbr>Placeholder</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="SnippetString.html#appendChoice" class="tsd-kind-icon">append<wbr>Choice</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="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</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="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/blob/ea3c2ef/vscode.d.ts#L3386">vscode.d.ts:3386</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="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</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/blob/ea3c2ef/vscode.d.ts#L3384">vscode.d.ts:3384</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</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="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/blob/ea3c2ef/vscode.d.ts#L3395">vscode.d.ts:3395</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="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 &#39;as given&#39;. The string will be escaped.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="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="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/blob/ea3c2ef/vscode.d.ts#L3405">vscode.d.ts:3405</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="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="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="SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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="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/blob/ea3c2ef/vscode.d.ts#L3417">vscode.d.ts:3417</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="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="SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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="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="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/blob/ea3c2ef/vscode.d.ts#L3428">vscode.d.ts:3428</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="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="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="SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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="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/blob/ea3c2ef/vscode.d.ts#L3439">vscode.d.ts:3439</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="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="SnippetString.html" class="tsd-signature-type" data-tsd-kind="Class">SnippetString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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="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>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="SnippetString.html" class="tsd-kind-icon">Snippet<wbr>String</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="SnippetString.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="SnippetString.html#value" class="tsd-kind-icon">value</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="SnippetString.html#appendText" class="tsd-kind-icon">append<wbr>Text</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="SnippetString.html#appendTabstop" class="tsd-kind-icon">append<wbr>Tabstop</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="SnippetString.html#appendPlaceholder" class="tsd-kind-icon">append<wbr>Placeholder</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="SnippetString.html#appendChoice" class="tsd-kind-icon">append<wbr>Choice</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="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>Legend</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 using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in new issue View Git Blame Copy Permalink