<!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 = "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 = "vscode.html" > vscode< / a >
< / li >
< li >
< a href = "vscode.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 = "vscode.commands.html#registerCommand" > registerCommand< / a >
and < a href = "vscode.commands.html#registerTextEditorCommand" > registerTextEditorCommand< / a > functions. Commands
can be executed < a href = "vscode.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 >
< dl class = "tsd-comment-tags" >
< dt > maintainer< / dt >
< dd > < p > < a href = "https://github.com/Imchenlong" class = "external" > @Imchenlong< / a > < / p >
< / dd >
< / dl >
< / 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 = "vscode.commands.html#registerCommand" class = "tsd-kind-icon" > register< wbr > Command< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.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 = "vscode.commands.html#executeCommand" class = "tsd-kind-icon" > execute< wbr > Command< / a > < / li >
< li class = "tsd-kind-function tsd-parent-kind-namespace" > < a href = "vscode.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/vscode.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/2404697/vscode.d.ts#L8483" > vscode.d.ts:8483< / 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/vscode.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/vscode.TextEditor.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextEditor< / a > , edit< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.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/vscode.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/2404697/vscode.d.ts#L8500" > vscode.d.ts:8500< / 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 = "vscode.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/vscode.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/vscode.TextEditor.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextEditor< / a > , edit< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.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/vscode.TextEditor.html" > editor< / a > and an < a href = "../interfaces/vscode.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/vscode.TextEditor.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextEditor< / a > , edit< span class = "tsd-signature-symbol" > : < / span > < a href = "../interfaces/vscode.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/vscode.TextEditor.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextEditor< / a > < / h5 >
< / li >
< li >
< h5 > edit: < a href = "../interfaces/vscode.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/vscode.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/2404697/vscode.d.ts#L8516" > vscode.d.ts:8516< / 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/vscode.Position.html" > < code > Position< / code > < / a > , < a href = "../classes/vscode.Range.html" > < code > Range< / code > < / a > , < a href = "../classes/vscode.Uri.html" > < code > Uri< / code > < / a > and < a href = "../classes/vscode.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/2404697/vscode.d.ts#L8525" > vscode.d.ts:8525< / 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 = "../modules.html" > Exports< / a >
< / li >
< li class = "current tsd-kind-namespace" >
< a href = "vscode.html" > vscode< / a >
< ul >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.authentication.html" > authentication< / a >
< / li >
< li class = "current tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.commands.html" > commands< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.comments.html" > comments< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.debug.html" > debug< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.env.html" > env< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.extensions.html" > extensions< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.languages.html" > languages< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.notebooks.html" > notebooks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.scm.html" > scm< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.tasks.html" > tasks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.tests.html" > tests< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "vscode.window.html" > window< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "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" >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.commands.html#registerCommand" class = "tsd-kind-icon" > register< wbr > Command< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.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 = "vscode.commands.html#executeCommand" class = "tsd-kind-icon" > execute< wbr > Command< / a >
< / li >
< li class = " tsd-kind-function tsd-parent-kind-namespace" >
< a href = "vscode.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" >
< / 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 >
