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.
444 lines
27 KiB
444 lines
27 KiB
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>commands | 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="../index.html">VS Code API 中文文档</a>
|
|
</li>
|
|
<li>
|
|
<a href="commands.html">commands</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Namespace commands</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 dealing with commands. In short, a command is a function with a
|
|
unique identifier. The function is sometimes also called <em>command handler</em>.</p>
|
|
</div>
|
|
<p>Commands can be added to the editor using the <a href="commands.html#registerCommand">registerCommand</a>
|
|
and <a href="commands.html#registerTextEditorCommand">registerTextEditorCommand</a> functions. Commands
|
|
can be executed <a href="commands.html#executeCommand">manually</a> or from a UI gesture. Those are:</p>
|
|
<ul>
|
|
<li>palette - Use the <code>commands</code>-section in <code>package.json</code> to make a command show in
|
|
the <a href="https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette">command palette</a>.</li>
|
|
<li>keybinding - Use the <code>keybindings</code>-section in <code>package.json</code> to enable
|
|
<a href="https://code.visualstudio.com/docs/getstarted/keybindings#_customizing-shortcuts">keybindings</a>
|
|
for your extension.</li>
|
|
</ul>
|
|
<p>Commands from other extensions and from the editor itself are accessible to an extension. However,
|
|
when invoking an editor command not all argument types are supported.</p>
|
|
<p>This is a sample that registers a command handler and adds an entry for that command to the palette. First
|
|
register a command handler with the identifier <code>extension.sayHello</code>.</p>
|
|
<pre><code class="language-javascript"><span style="color: #001080">commands</span><span style="color: #000000">.</span><span style="color: #795E26">registerCommand</span><span style="color: #000000">(</span><span style="color: #A31515">'extension.sayHello'</span><span style="color: #000000">, () </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">window</span><span style="color: #000000">.</span><span style="color: #795E26">showInformationMessage</span><span style="color: #000000">(</span><span style="color: #A31515">'Hello World!'</span><span style="color: #000000">);</span>
|
|
<span style="color: #000000">});</span>
|
|
</code></pre>
|
|
<p>Second, bind the command identifier to a title under which it will show in the palette (<code>package.json</code>).</p>
|
|
<pre><code class="language-json"><span style="color: #000000">{</span>
|
|
<span style="color: #000000"> </span><span style="color: #0451A5">"contributes"</span><span style="color: #000000">: {</span>
|
|
<span style="color: #000000"> </span><span style="color: #0451A5">"commands"</span><span style="color: #000000">: [{</span>
|
|
<span style="color: #000000"> </span><span style="color: #0451A5">"command"</span><span style="color: #000000">: </span><span style="color: #A31515">"extension.sayHello"</span><span style="color: #000000">,</span>
|
|
<span style="color: #000000"> </span><span style="color: #0451A5">"title"</span><span style="color: #000000">: </span><span style="color: #A31515">"Hello World"</span>
|
|
<span style="color: #000000"> }]</span>
|
|
<span style="color: #000000"> }</span>
|
|
<span style="color: #000000">}</span>
|
|
</code></pre>
|
|
</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="commands.html#registerCommand" class="tsd-kind-icon">register<wbr>Command</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="commands.html#registerTextEditorCommand" class="tsd-kind-icon">register<wbr>Text<wbr>Editor<wbr>Command</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="commands.html#executeCommand" class="tsd-kind-icon">execute<wbr>Command</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="commands.html#getCommands" class="tsd-kind-icon">get<wbr>Commands</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="registerCommand" class="tsd-anchor"></a>
|
|
<h3>register<wbr>Command</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Command<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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><span class="tsd-signature-type">any</span>, thisArg<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><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/843dcbe/vscode.d.ts#L8372">vscode.d.ts:8372</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Registers a command that can be invoked via a keyboard shortcut,
|
|
a menu item, an action, or directly.</p>
|
|
</div>
|
|
<p>Registering a command with an existing command identifier twice
|
|
will cause an error.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A unique identifier for the command.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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><span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A command handler function.</p>
|
|
</div>
|
|
<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><span class="tsd-signature-symbol">...</span>args<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><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><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></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> thisArg: <span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The <code>this</code> context used when invoking the handler function.</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>Disposable which unregisters this command on disposal.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
<a name="registerTextEditorCommand" class="tsd-anchor"></a>
|
|
<h3>register<wbr>Text<wbr>Editor<wbr>Command</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Text<wbr>Editor<wbr>Command<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>textEditor<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a>, edit<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorEdit.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorEdit</a>, <span class="tsd-signature-symbol">...</span>args<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><span class="tsd-signature-type">void</span>, thisArg<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><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/843dcbe/vscode.d.ts#L8389">vscode.d.ts:8389</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Registers a text editor command that can be invoked via a keyboard shortcut,
|
|
a menu item, an action, or directly.</p>
|
|
</div>
|
|
<p>Text editor commands are different from ordinary <a href="commands.html#registerCommand">commands</a> as
|
|
they only execute when there is an active editor when the command is called. Also, the
|
|
command handler of an editor command has access to the active editor and to an
|
|
<a href="../interfaces/TextEditorEdit.html">edit</a>-builder. Note that the edit-builder is only valid while the
|
|
callback executes.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A unique identifier for the command.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>callback: <span class="tsd-signature-symbol">(</span>textEditor<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a>, edit<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorEdit.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorEdit</a>, <span class="tsd-signature-symbol">...</span>args<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><span class="tsd-signature-type">void</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A command handler function with access to an <a href="../interfaces/TextEditor.html">editor</a> and an <a href="../interfaces/TextEditorEdit.html">edit</a>.</p>
|
|
</div>
|
|
<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>textEditor<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a>, edit<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorEdit.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorEdit</a>, <span class="tsd-signature-symbol">...</span>args<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><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>textEditor: <a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>edit: <a href="../interfaces/TextEditorEdit.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorEdit</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArg: <span class="tsd-signature-type">any</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The <code>this</code> context used when invoking the handler function.</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>Disposable which unregisters this command on disposal.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
<a name="executeCommand" class="tsd-anchor"></a>
|
|
<h3>execute<wbr>Command</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">execute<wbr>Command<T><span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>rest<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="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</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/843dcbe/vscode.d.ts#L8405">vscode.d.ts:8405</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Executes the command denoted by the given command identifier.</p>
|
|
</div>
|
|
<ul>
|
|
<li><em>Note 1:</em> When executing an editor command not all types are allowed to
|
|
be passed as arguments. Allowed are the primitive types <code>string</code>, <code>boolean</code>,
|
|
<code>number</code>, <code>undefined</code>, and <code>null</code>, as well as <a href="../classes/Position.html"><code>Position</code></a>, <a href="../classes/Range.html"><code>Range</code></a>, <a href="../classes/Uri.html"><code>Uri</code></a> and <a href="../classes/Location.html"><code>Location</code></a>.</li>
|
|
<li><em>Note 2:</em> There are no restrictions when executing commands that have been contributed
|
|
by extensions.</li>
|
|
</ul>
|
|
</div>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T</h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>command: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Identifier of the command to execute.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>rest: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Parameters passed to the command function.</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><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>A thenable that resolves to the returned value of the given command. <code>undefined</code> when
|
|
the command handler function doesn't return anything.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
<a name="getCommands" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Commands</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Commands<span class="tsd-signature-symbol">(</span>filterInternal<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><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><span class="tsd-signature-type">string</span><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/843dcbe/vscode.d.ts#L8414">vscode.d.ts:8414</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieve the list of all available commands. Commands starting with an underscore are
|
|
treated as internal commands.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> filterInternal: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Set <code>true</code> to not see internal commands (starting with an underscore)</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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>Thenable that resolves to a list of command ids.</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="../index.html">Exports</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="authentication.html">authentication</a>
|
|
</li>
|
|
<li class="current 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=" 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="commands.html#registerCommand" class="tsd-kind-icon">register<wbr>Command</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="commands.html#registerTextEditorCommand" class="tsd-kind-icon">register<wbr>Text<wbr>Editor<wbr>Command</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
<a href="commands.html#executeCommand" class="tsd-kind-icon">execute<wbr>Command</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="commands.html#getCommands" class="tsd-kind-icon">get<wbr>Commands</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> |