<!doctype html>
< html class = "default no-js" lang = "zh-CN" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > Extension | VS Code API 中文文档< / title >
< meta name = "description" content = "VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API， >
< meta name = "author" content = "洛竹" >
< meta name = "copyright" content = "洛竹" >
< meta property = "og:type" content = "docs" >
< meta property = "og:url" content = "https://vscode-api-cn.js.org/index.html" >
< meta property = "og:site_name" content = "Vscode Api 中文文档" >
< meta property = "article:tag" content = "vscode api" >
< meta property = "article:tag" content = "vscode api 中文文档" >
< meta property = "article:tag" content = "vscode 插件" >
< meta property = "article:tag" content = "vscode 插件开发" >
< meta property = "article:tag" content = "vscode Extension" >
< meta property = "og:description" content = "VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript 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 = 'canonical' href = 'https://vscode-api-cn.js.org/' / >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< script async src = "https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-7962287588031867" crossorigin = "anonymous" > < / script >
< script type = "text/javascript" >
(function (c, l, a, r, i, t, y) {
c[a] = c[a] || function () { (c[a].q = c[a].q || []).push(arguments) };
t = l.createElement(r); t.async = 1; t.src = "https://www.clarity.ms/tag/" + i;
y = l.getElementsByTagName(r)[0]; y.parentNode.insertBefore(t, y);
})(window, document, "clarity", "script", "g1cbw4nxoq");
< / script >
<!-- Google tag (gtag.js) -->
< script async src = "https://www.googletagmanager.com/gtag/js?id=G-T4TRRS1LB1" > < / script >
< script >
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-T4TRRS1LB1');
< / script >
< style >
.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.Extension.html" > Extension< / a >
< / li >
< / ul >
< h1 > Interface Extension< T> < / 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 > Represents an extension.< / p >
< / div >
< p > To get an instance of an < code > Extension< / code > use < a href = "../modules/vscode.extensions.html#getExtension" > getExtension< / a > .< / p >
< / div >
< / section >
< section class = "tsd-panel tsd-type-parameters" >
< h3 > Type parameters< / h3 >
< ul class = "tsd-type-parameters" >
< li >
< h4 > T< / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > 层级< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > Extension< / 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 > Properties（ ） < / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "vscode.Extension.html#id" class = "tsd-kind-icon" > id< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "vscode.Extension.html#extensionUri" class = "tsd-kind-icon" > extension< wbr > Uri< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "vscode.Extension.html#extensionPath" class = "tsd-kind-icon" > extension< wbr > Path< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "vscode.Extension.html#isActive" class = "tsd-kind-icon" > is< wbr > Active< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "vscode.Extension.html#packageJSON" class = "tsd-kind-icon" > packageJSON< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "vscode.Extension.html#extensionKind" class = "tsd-kind-icon" > extension< wbr > Kind< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "vscode.Extension.html#exports" class = "tsd-kind-icon" > exports< / 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-interface" > < a href = "vscode.Extension.html#activate" class = "tsd-kind-icon" > activate< / a > < / li >
< / ul >
< / section >
< / div >
< / 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-interface" >
< a name = "id" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > id< / h3 >
< div class = "tsd-signature tsd-kind-icon" > id< 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/828f462/vscode.d.ts#L5980" > vscode.d.ts:5980< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The canonical extension identifier in the form of: < code > publisher.name< / code > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "extensionUri" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > extension< wbr > Uri< / h3 >
< div class = "tsd-signature tsd-kind-icon" > extension< wbr > Uri< span class = "tsd-signature-symbol" > :< / span > < a href = "../classes/vscode.Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L5985" > vscode.d.ts:5985< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The uri of the directory containing the extension.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "extensionPath" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > extension< wbr > Path< / h3 >
< div class = "tsd-signature tsd-kind-icon" > extension< wbr > Path< 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/828f462/vscode.d.ts#L5991" > vscode.d.ts:5991< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The absolute file path of the directory containing this extension. Shorthand
notation for < a href = "vscode.Extension.html#extensionUri" > Extension.extensionUri.fsPath< / a > (independent of the uri scheme).< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "isActive" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > is< wbr > Active< / h3 >
< div class = "tsd-signature tsd-kind-icon" > is< wbr > Active< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L5996" > vscode.d.ts:5996< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > < code > true< / code > if the extension has been activated.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "packageJSON" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > packageJSON< / h3 >
< div class = "tsd-signature tsd-kind-icon" > packageJSON< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > any< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L6001" > vscode.d.ts:6001< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The parsed contents of the extension' s package.json.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "extensionKind" class = "tsd-anchor" > < / a >
< h3 > extension< wbr > Kind< / h3 >
< div class = "tsd-signature tsd-kind-icon" > extension< wbr > Kind< span class = "tsd-signature-symbol" > :< / span > < a href = "../enums/vscode.ExtensionKind.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > ExtensionKind< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L6010" > vscode.d.ts:6010< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The extension kind describes if an extension runs where the UI runs
or if an extension runs where the remote extension host runs. The extension kind
is defined in the < code > package.json< / code > -file of extensions but can also be refined
via the < code > remote.extensionKind< / code > -setting. When no remote extension host exists,
the value is < a href = "../enums/vscode.ExtensionKind.html#UI" > < code > ExtensionKind.UI< / code > < / a > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "exports" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > exports< / h3 >
< div class = "tsd-signature tsd-kind-icon" > exports< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > T< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L6016" > vscode.d.ts:6016< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The public API exported by this extension. It is an invalid action
to access this field before this extension has been activated.< / 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-interface" >
< a name = "activate" class = "tsd-anchor" > < / a >
< h3 > activate< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > activate< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "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 > < / 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/828f462/vscode.d.ts#L6023" > vscode.d.ts:6023< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Activates this extension and returns its public API.< / p >
< / div >
< / div >
< h4 class = "tsd-returns-title" > Returns < a href = "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 > < / h4 >
< p > A promise that will resolve when this extension has been activated.< / 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-interface tsd-parent-kind-namespace tsd-has-type-parameter" >
< a href = "vscode.Extension.html" class = "tsd-kind-icon" > Extension< / a >
< ul >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "vscode.Extension.html#id" class = "tsd-kind-icon" > id< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "vscode.Extension.html#extensionUri" class = "tsd-kind-icon" > extension< wbr > Uri< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "vscode.Extension.html#extensionPath" class = "tsd-kind-icon" > extension< wbr > Path< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "vscode.Extension.html#isActive" class = "tsd-kind-icon" > is< wbr > Active< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "vscode.Extension.html#packageJSON" class = "tsd-kind-icon" > packageJSON< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "vscode.Extension.html#extensionKind" class = "tsd-kind-icon" > extension< wbr > Kind< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "vscode.Extension.html#exports" class = "tsd-kind-icon" > exports< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "vscode.Extension.html#activate" class = "tsd-kind-icon" > activate< / 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-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 >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > 友链：< 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 > . Maintained by < a href = "https://youngjuning.js.org" target = "_blank" > 洛竹< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< script type = 'text/javascript' src = '//harassinganticipation.com/49/55/54/495554c56caa1155c7e9c5609d16b472.js' > < / script >
< / body >
< / html >
