|
|
<!doctype html>
|
|
|
<html class="default no-js">
|
|
|
<head>
|
|
|
<meta charset="utf-8">
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
<title>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="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-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>
|
|
|
<style>
|
|
|
.github-corner svg {
|
|
|
z-index: 1;
|
|
|
}
|
|
|
.github-corner:hover .octo-arm {
|
|
|
animation:octocat-wave 560ms ease-in-out
|
|
|
}
|
|
|
@keyframes octocat-wave {
|
|
|
0%,100%{transform:rotate(0)}
|
|
|
20%,60%{transform:rotate(-25deg)}
|
|
|
40%,80%{transform:rotate(10deg)}
|
|
|
}
|
|
|
@media (max-width:500px) {
|
|
|
.github-corner:hover
|
|
|
.octo-arm{animation:none}
|
|
|
.github-corner .octo-arm{
|
|
|
animation:octocat-wave 560ms ease-in-out
|
|
|
}
|
|
|
}
|
|
|
.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">
|
|
|
<h1>VS Code API 中文文档</h1>
|
|
|
</div>
|
|
|
</div>
|
|
|
</header>
|
|
|
<div class="container container-main">
|
|
|
<div class="row">
|
|
|
<div class="col-8 col-content">
|
|
|
<div class="tsd-panel tsd-typography">
|
|
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
|
<p><a href="#contributors-"><img src="https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square" alt="All Contributors"></a></p>
|
|
|
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
|
|
<p>VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API。这个站点列出了扩展开发者可以使用的所有 VS Code API。原网站没有中文翻译且不方便阅读，所以有了该网站。</p>
|
|
|
<p>API 列表使用 Typedoc 从 <a href="https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts">vscode.d.ts</a> 文件编译而来，如果 <a href="https://github.com/microsoft/vscode/blob/main/src/vs/vscode.d.ts">vscode.d.ts 源文件</a> 有更新，我们会及时同步，当前对应 commit 为 <a href="https://github.com/microsoft/vscode/commit/2974a014fd33f4a109aad6ed0f3e46fe93bfc794#diff-f127724f8c5dbf0c8371ad0a100f8a9bc0a398b6b8ec29aa6cd7f265bd01a096">2974a01</a>。</p>
|
|
|
<a href="#贡献指南" id="贡献指南" style="color: inherit; text-decoration: none;">
|
|
|
<h2>贡献指南</h2>
|
|
|
</a>
|
|
|
<ul>
|
|
|
<li><a href="https://github.com/vscode-cn/vscode-api-cn/issues/27">专业术语</a></li>
|
|
|
<li><a href="https://github.com/vscode-cn/vscode-api-cn/issues/25">翻译认领</a></li>
|
|
|
</ul>
|
|
|
<a href="#成为译者" id="成为译者" style="color: inherit; text-decoration: none;">
|
|
|
<h3>成为译者</h3>
|
|
|
</a>
|
|
|
<ul>
|
|
|
<li><strong>外部译者</strong>：对 <em>vscode.d.ts</em> 文件的注释进行翻译，然后提交 PR 即可。</li>
|
|
|
<li><strong>内部译者</strong>：需要负责某一具体模块，如果感兴趣可以添加管理员微信（<code>yang_jun_ning</code>）申请。</li>
|
|
|
</ul>
|
|
|
<a href="#本地预览" id="本地预览" style="color: inherit; text-decoration: none;">
|
|
|
<h3>本地预览</h3>
|
|
|
</a>
|
|
|
<ol>
|
|
|
<li><strong>安装依赖</strong>：<code>yarn install</code></li>
|
|
|
<li><strong>开启调试</strong>：<code>yarn dev</code></li>
|
|
|
<li><strong>开启服务</strong>：<code>yarn start</code></li>
|
|
|
</ol>
|
|
|
<a href="#贡献者-✨" id="贡献者-✨" style="color: inherit; text-decoration: none;">
|
|
|
<h2>贡献者 ✨</h2>
|
|
|
</a>
|
|
|
<p>感谢这些优秀的人 (<a href="https://allcontributors.org/docs/en/emoji-key">emoji key</a>)：</p>
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
|
<!-- prettier-ignore-start -->
|
|
|
<!-- markdownlint-disable -->
|
|
|
<table>
|
|
|
<tr>
|
|
|
<td align="center"><a href="https://github.com/youngjuning"><img src="https://avatars.githubusercontent.com/u/13204332?v=4?s=100" width="100px;" alt=""/><br /><sub><b>youngjuning</b></sub></a><br /><a href="https://github.com/vscode-cn/vscode-api-cn/commits?author=youngjuning" title="Code">💻</a> <a href="#maintenance-youngjuning" title="Maintenance">🚧</a> <a href="#translation-youngjuning" title="Translation">🌍</a> <a href="https://github.com/vscode-cn/vscode-api-cn/commits?author=youngjuning" title="Documentation">📖</a> <a href="#ideas-youngjuning" title="Ideas, Planning, & Feedback">🤔</a></td>
|
|
|
<td align="center"><a href="https://github.com/gepingli"><img src="https://avatars.githubusercontent.com/u/29964332?v=4?s=100" width="100px;" alt=""/><br /><sub><b>gepingli</b></sub></a><br /><a href="#translation-gepingli" title="Translation">🌍</a> <a href="#ideas-gepingli" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/vscode-cn/vscode-api-cn/commits?author=gepingli" title="Code">💻</a></td>
|
|
|
<td align="center"><a href="http://saber2pr.top"><img src="https://avatars.githubusercontent.com/u/40260564?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Konpaku Youmu</b></sub></a><br /><a href="#translation-Saber2pr" title="Translation">🌍</a> <a href="#ideas-Saber2pr" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-Saber2pr" title="Maintenance">🚧</a> <a href="https://github.com/vscode-cn/vscode-api-cn/commits?author=Saber2pr" title="Code">💻</a></td>
|
|
|
<td align="center"><a href="https://github.com/Imchenlong"><img src="https://avatars.githubusercontent.com/u/13520451?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Lance Chen</b></sub></a><br /><a href="#translation-Imchenlong" title="Translation">🌍</a> <a href="#maintenance-Imchenlong" title="Maintenance">🚧</a> <a href="https://github.com/vscode-cn/vscode-api-cn/commits?author=Imchenlong" title="Code">💻</a></td>
|
|
|
<td align="center"><a href="https://github.com/pan463859"><img src="https://avatars.githubusercontent.com/u/32640880?v=4?s=100" width="100px;" alt=""/><br /><sub><b>潘小安</b></sub></a><br /><a href="#translation-pan463859" title="Translation">🌍</a> <a href="#maintenance-pan463859" title="Maintenance">🚧</a> <a href="#ideas-pan463859" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/vscode-cn/vscode-api-cn/commits?author=pan463859" title="Code">💻</a></td>
|
|
|
<td align="center"><a href="https://github.com/sherry-zxy"><img src="https://avatars.githubusercontent.com/u/36014195?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Xiyuan Zheng</b></sub></a><br /><a href="#translation-sherry-zxy" title="Translation">🌍</a> <a href="https://github.com/vscode-cn/vscode-api-cn/commits?author=sherry-zxy" title="Code">💻</a></td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td align="center"><a href="https://juejin.cn/user/3993025017037309/posts"><img src="https://avatars.githubusercontent.com/u/43341115?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Liuqh233</b></sub></a><br /><a href="#translation-liuqh0609" title="Translation">🌍</a> <a href="https://github.com/vscode-cn/vscode-api-cn/commits?author=liuqh0609" title="Code">💻</a></td>
|
|
|
<td align="center"><a href="https://github.com/cxk0831"><img src="https://avatars.githubusercontent.com/u/34495411?v=4?s=100" width="100px;" alt=""/><br /><sub><b>竹雨</b></sub></a><br /><a href="#translation-cxk0831" title="Translation">🌍</a> <a href="https://github.com/vscode-cn/vscode-api-cn/commits?author=cxk0831" title="Code">💻</a></td>
|
|
|
<td align="center"><a href="https://github.com/yangyang825"><img src="https://avatars.githubusercontent.com/u/84166052?v=4?s=100" width="100px;" alt=""/><br /><sub><b>yangyang825</b></sub></a><br /><a href="#translation-yangyang825" title="Translation">🌍</a></td>
|
|
|
</tr>
|
|
|
</table>
|
|
|
<!-- markdownlint-restore -->
|
|
|
<!-- prettier-ignore-end -->
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
|
<p>本项目遵循 <a href="https://github.com/all-contributors/all-contributors">all-contributors</a> 规范。欢迎任何形式的贡献!</p>
|
|
|
</div>
|
|
|
</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=" tsd-kind-namespace">
|
|
|
<a href="modules/vscode.html">vscode</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</nav>
|
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
|
<ul class="before-current">
|
|
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
|
|
<a href="interfaces/Thenable.html" class="tsd-kind-icon">Thenable</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(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
|
|
|
|
ga('create', 'G-T4TRRS1LB1', 'auto');
|
|
|
ga('send', 'pageview');
|
|
|
</script>
|
|
|
<a href="https://github.com/youngjuning/vscode-api-cn" target="_blank" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: fixed; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>
|
|
|
</body>
|
|
|
</html> |
