|
|
<!doctype html>
|
|
|
<html class="default no-js">
|
|
|
<head>
|
|
|
<meta charset="utf-8">
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
<title>languages | 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-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>
|
|
|
.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">
|
|
|
<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.languages.html">languages</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h1>Namespace languages</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 participating in language-specific editor <a href="https://code.visualstudio.com/docs/editor/editingevolved">features</a>,
|
|
|
like IntelliSense, code actions, diagnostics etc.</p>
|
|
|
</div>
|
|
|
<p>Many programming languages exist and there is huge variety in syntaxes, semantics, and paradigms. Despite that, features
|
|
|
like automatic word-completion, code navigation, or code checking have become popular across different tools for different
|
|
|
programming languages.</p>
|
|
|
<p>The editor provides an API that makes it simple to provide such common features by having all UI and actions already in place and
|
|
|
by allowing you to participate by providing data only. For instance, to contribute a hover all you have to do is provide a function
|
|
|
that can be called with a <a href="../interfaces/vscode.TextDocument.html">TextDocument</a> and a <a href="../classes/vscode.Position.html">Position</a> returning hover info. The rest, like tracking the
|
|
|
mouse, positioning the hover, keeping the hover stable etc. is taken care of by the editor.</p>
|
|
|
<pre><code class="language-javascript"><span style="color: #001080">languages</span><span style="color: #000000">.</span><span style="color: #795E26">registerHoverProvider</span><span style="color: #000000">(</span><span style="color: #A31515">'javascript'</span><span style="color: #000000">, {</span>
|
|
|
<span style="color: #000000"> </span><span style="color: #795E26">provideHover</span><span style="color: #000000">(</span><span style="color: #001080">document</span><span style="color: #000000">, </span><span style="color: #001080">position</span><span style="color: #000000">, </span><span style="color: #001080">token</span><span style="color: #000000">) {</span>
|
|
|
<span style="color: #000000"> </span><span style="color: #AF00DB">return</span><span style="color: #000000"> </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Hover</span><span style="color: #000000">(</span><span style="color: #A31515">'I am a hover!'</span><span style="color: #000000">);</span>
|
|
|
<span style="color: #000000"> }</span>
|
|
|
<span style="color: #000000">});</span>
|
|
|
</code></pre>
|
|
|
<p>Registration is done using a <a href="vscode.html#DocumentSelector">document selector</a> which is either a language id, like <code>javascript</code> or
|
|
|
a more complex <a href="../interfaces/vscode.DocumentFilter.html">filter</a> like <code>{ language: 'typescript', scheme: 'file' }</code>. Matching a document against such
|
|
|
a selector will result in a <a href="vscode.languages.html#match">score</a> that is used to determine if and how a provider shall be used. When
|
|
|
scores are equal the provider that came last wins. For features that allow full arity, like <a href="vscode.languages.html#registerHoverProvider">hover</a>,
|
|
|
the score is only checked to be <code>>0</code>, for other features, like <a href="vscode.languages.html#registerCompletionItemProvider">IntelliSense</a> the
|
|
|
score is used for determining the order in which providers are asked to participate.</p>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>maintainer</dt>
|
|
|
<dd><p><a href="https://github.com/youngjuning" class="external">@youngjuning</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（34）</h3>
|
|
|
<ul class="tsd-index-list">
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#getLanguages" class="tsd-kind-icon">get<wbr>Languages</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#setTextDocumentLanguage" class="tsd-kind-icon">set<wbr>Text<wbr>Document<wbr>Language</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#match" class="tsd-kind-icon">match</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#onDidChangeDiagnostics" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Diagnostics</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#getDiagnostics" class="tsd-kind-icon">get<wbr>Diagnostics</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#createDiagnosticCollection" class="tsd-kind-icon">create<wbr>Diagnostic<wbr>Collection</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerCompletionItemProvider" class="tsd-kind-icon">register<wbr>Completion<wbr>Item<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerCodeActionsProvider" class="tsd-kind-icon">register<wbr>Code<wbr>Actions<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerCodeLensProvider" class="tsd-kind-icon">register<wbr>Code<wbr>Lens<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerDefinitionProvider" class="tsd-kind-icon">register<wbr>Definition<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerImplementationProvider" class="tsd-kind-icon">register<wbr>Implementation<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerTypeDefinitionProvider" class="tsd-kind-icon">register<wbr>Type<wbr>Definition<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerDeclarationProvider" class="tsd-kind-icon">register<wbr>Declaration<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerHoverProvider" class="tsd-kind-icon">register<wbr>Hover<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerEvaluatableExpressionProvider" class="tsd-kind-icon">register<wbr>Evaluatable<wbr>Expression<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerInlineValuesProvider" class="tsd-kind-icon">register<wbr>Inline<wbr>Values<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerDocumentHighlightProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Highlight<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerDocumentSymbolProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Symbol<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerWorkspaceSymbolProvider" class="tsd-kind-icon">register<wbr>Workspace<wbr>Symbol<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerReferenceProvider" class="tsd-kind-icon">register<wbr>Reference<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerRenameProvider" class="tsd-kind-icon">register<wbr>Rename<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerDocumentSemanticTokensProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Semantic<wbr>Tokens<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerDocumentRangeSemanticTokensProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Range<wbr>Semantic<wbr>Tokens<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerDocumentFormattingEditProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Formatting<wbr>Edit<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerDocumentRangeFormattingEditProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Range<wbr>Formatting<wbr>Edit<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerOnTypeFormattingEditProvider" class="tsd-kind-icon">register<wbr>OnType<wbr>Formatting<wbr>Edit<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerSignatureHelpProvider" class="tsd-kind-icon">register<wbr>Signature<wbr>Help<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerDocumentLinkProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Link<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerColorProvider" class="tsd-kind-icon">register<wbr>Color<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerFoldingRangeProvider" class="tsd-kind-icon">register<wbr>Folding<wbr>Range<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerSelectionRangeProvider" class="tsd-kind-icon">register<wbr>Selection<wbr>Range<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerCallHierarchyProvider" class="tsd-kind-icon">register<wbr>Call<wbr>Hierarchy<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#registerLinkedEditingRangeProvider" class="tsd-kind-icon">register<wbr>Linked<wbr>Editing<wbr>Range<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="vscode.languages.html#setLanguageConfiguration" class="tsd-kind-icon">set<wbr>Language<wbr>Configuration</a></li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
</div>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
<h2>Functions（34）</h2>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="getLanguages" class="tsd-anchor"></a>
|
|
|
<h3>get<wbr>Languages</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Languages<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">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/5f7ad41/vscode.d.ts#L11140">vscode.d.ts:11140</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Return the identifiers of all known languages.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<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>Promise resolving to an array of identifier strings.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="setTextDocumentLanguage" class="tsd-anchor"></a>
|
|
|
<h3>set<wbr>Text<wbr>Document<wbr>Language</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Text<wbr>Document<wbr>Language<span class="tsd-signature-symbol">(</span>document<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.TextDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocument</a>, languageId<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="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/vscode.TextDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocument</a><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/5f7ad41/vscode.d.ts#L11153">vscode.d.ts:11153</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Set (and change) the <a href="../interfaces/vscode.TextDocument.html#languageId">language</a> that is associated
|
|
|
with the given document.</p>
|
|
|
</div>
|
|
|
<p><em>Note</em> that calling this function will trigger the <a href="vscode.workspace.html#onDidCloseTextDocument"><code>onDidCloseTextDocument</code></a> event
|
|
|
followed by the <a href="vscode.workspace.html#onDidOpenTextDocument"><code>onDidOpenTextDocument</code></a> event.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>document: <a href="../interfaces/vscode.TextDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocument</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The document which language is to be changed</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>languageId: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The new language identifier.</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><a href="../interfaces/vscode.TextDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocument</a><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A thenable that resolves with the updated document.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="match" class="tsd-anchor"></a>
|
|
|
<h3>match</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">match<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, document<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.TextDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocument</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/5f7ad41/vscode.d.ts#L11192">vscode.d.ts:11192</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Compute the match between a document <a href="vscode.html#DocumentSelector">selector</a> and a document. Values
|
|
|
greater than zero mean the selector matches the document.</p>
|
|
|
</div>
|
|
|
<p>A match is computed according to these rules:</p>
|
|
|
<ol>
|
|
|
<li>When <a href="vscode.html#DocumentSelector"><code>DocumentSelector</code></a> is an array, compute the match for each contained <code>DocumentFilter</code> or language identifier and take the maximum value.</li>
|
|
|
<li>A string will be desugared to become the <code>language</code>-part of a <a href="../interfaces/vscode.DocumentFilter.html"><code>DocumentFilter</code></a>, so <code>"fooLang"</code> is like <code>{ language: "fooLang" }</code>.</li>
|
|
|
<li>A <a href="../interfaces/vscode.DocumentFilter.html"><code>DocumentFilter</code></a> will be matched against the document by comparing its parts with the document. The following rules apply:</li>
|
|
|
<li>When the <code>DocumentFilter</code> is empty (<code>{}</code>) the result is <code>0</code></li>
|
|
|
<li>When <code>scheme</code>, <code>language</code>, or <code>pattern</code> are defined but one doesn’t match, the result is <code>0</code></li>
|
|
|
<li>Matching against <code>*</code> gives a score of <code>5</code>, matching via equality or via a glob-pattern gives a score of <code>10</code></li>
|
|
|
<li>The result is the maximum value of each match</li>
|
|
|
</ol>
|
|
|
<p>Samples:</p>
|
|
|
<pre><code class="language-js"><span style="color: #008000">// default document from disk (file-scheme)</span>
|
|
|
<span style="color: #001080">doc</span><span style="color: #000000">.</span><span style="color: #001080">uri</span><span style="color: #000000">; </span><span style="color: #008000">//'file:///my/file.js'</span>
|
|
|
<span style="color: #001080">doc</span><span style="color: #000000">.</span><span style="color: #001080">languageId</span><span style="color: #000000">; </span><span style="color: #008000">// 'javascript'</span>
|
|
|
<span style="color: #795E26">match</span><span style="color: #000000">(</span><span style="color: #A31515">'javascript'</span><span style="color: #000000">, </span><span style="color: #001080">doc</span><span style="color: #000000">); </span><span style="color: #008000">// 10;</span>
|
|
|
<span style="color: #795E26">match</span><span style="color: #000000">({</span><span style="color: #001080">language:</span><span style="color: #000000"> </span><span style="color: #A31515">'javascript'</span><span style="color: #000000">}, </span><span style="color: #001080">doc</span><span style="color: #000000">); </span><span style="color: #008000">// 10;</span>
|
|
|
<span style="color: #795E26">match</span><span style="color: #000000">({</span><span style="color: #001080">language:</span><span style="color: #000000"> </span><span style="color: #A31515">'javascript'</span><span style="color: #000000">, </span><span style="color: #001080">scheme:</span><span style="color: #000000"> </span><span style="color: #A31515">'file'</span><span style="color: #000000">}, </span><span style="color: #001080">doc</span><span style="color: #000000">); </span><span style="color: #008000">// 10;</span>
|
|
|
<span style="color: #795E26">match</span><span style="color: #000000">(</span><span style="color: #A31515">'*'</span><span style="color: #000000">, </span><span style="color: #001080">doc</span><span style="color: #000000">); </span><span style="color: #008000">// 5</span>
|
|
|
<span style="color: #795E26">match</span><span style="color: #000000">(</span><span style="color: #A31515">'fooLang'</span><span style="color: #000000">, </span><span style="color: #001080">doc</span><span style="color: #000000">); </span><span style="color: #008000">// 0</span>
|
|
|
<span style="color: #795E26">match</span><span style="color: #000000">([</span><span style="color: #A31515">'fooLang'</span><span style="color: #000000">, </span><span style="color: #A31515">'*'</span><span style="color: #000000">], </span><span style="color: #001080">doc</span><span style="color: #000000">); </span><span style="color: #008000">// 5</span>
|
|
|
|
|
|
<span style="color: #008000">// virtual document, e.g. from git-index</span>
|
|
|
<span style="color: #001080">doc</span><span style="color: #000000">.</span><span style="color: #001080">uri</span><span style="color: #000000">; </span><span style="color: #008000">// 'git:/my/file.js'</span>
|
|
|
<span style="color: #001080">doc</span><span style="color: #000000">.</span><span style="color: #001080">languageId</span><span style="color: #000000">; </span><span style="color: #008000">// 'javascript'</span>
|
|
|
<span style="color: #795E26">match</span><span style="color: #000000">(</span><span style="color: #A31515">'javascript'</span><span style="color: #000000">, </span><span style="color: #001080">doc</span><span style="color: #000000">); </span><span style="color: #008000">// 10;</span>
|
|
|
<span style="color: #795E26">match</span><span style="color: #000000">({</span><span style="color: #001080">language:</span><span style="color: #000000"> </span><span style="color: #A31515">'javascript'</span><span style="color: #000000">, </span><span style="color: #001080">scheme:</span><span style="color: #000000"> </span><span style="color: #A31515">'git'</span><span style="color: #000000">}, </span><span style="color: #001080">doc</span><span style="color: #000000">); </span><span style="color: #008000">// 10;</span>
|
|
|
<span style="color: #795E26">match</span><span style="color: #000000">(</span><span style="color: #A31515">'*'</span><span style="color: #000000">, </span><span style="color: #001080">doc</span><span style="color: #000000">); </span><span style="color: #008000">// 5</span>
|
|
|
</code></pre>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A document selector.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>document: <a href="../interfaces/vscode.TextDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocument</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A text document.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
|
<p>A number <code>>0</code> when the selector matches and <code>0</code> when the selector does not match.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="onDidChangeDiagnostics" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Change<wbr>Diagnostics</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Diagnostics<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.DiagnosticChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagnosticChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/vscode.Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</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/5f7ad41/vscode.d.ts#L11198">vscode.d.ts:11198</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An <a href="../interfaces/vscode.Event.html">Event</a> which fires when the global set of diagnostics changes. This is
|
|
|
newly added and removed diagnostics.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.DiagnosticChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagnosticChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
|
<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>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.DiagnosticChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagnosticChangeEvent</a><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>e: <a href="../interfaces/vscode.DiagnosticChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagnosticChangeEvent</a></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> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/vscode.Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
</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>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="getDiagnostics" class="tsd-anchor"></a>
|
|
|
<h3>get<wbr>Diagnostics</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Diagnostics<span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../classes/vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/vscode.Diagnostic.html" class="tsd-signature-type" data-tsd-kind="Class">Diagnostic</a><span class="tsd-signature-symbol">[]</span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Diagnostics<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><a href="../classes/vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol">, </span><a href="../classes/vscode.Diagnostic.html" class="tsd-signature-type" data-tsd-kind="Class">Diagnostic</a><span class="tsd-signature-symbol">[]</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/5f7ad41/vscode.d.ts#L11206">vscode.d.ts:11206</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Get all diagnostics for a given resource.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>resource: <a href="../classes/vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A resource</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/vscode.Diagnostic.html" class="tsd-signature-type" data-tsd-kind="Class">Diagnostic</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
|
<p>An array of <a href="../classes/vscode.Diagnostic.html">diagnostics</a> objects or an empty array.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5f7ad41/vscode.d.ts#L11213">vscode.d.ts:11213</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Get all diagnostics.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><a href="../classes/vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol">, </span><a href="../classes/vscode.Diagnostic.html" class="tsd-signature-type" data-tsd-kind="Class">Diagnostic</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
|
<p>An array of uri-diagnostics tuples or an empty array.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="createDiagnosticCollection" class="tsd-anchor"></a>
|
|
|
<h3>create<wbr>Diagnostic<wbr>Collection</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Diagnostic<wbr>Collection<span class="tsd-signature-symbol">(</span>name<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="../interfaces/vscode.DiagnosticCollection.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagnosticCollection</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/5f7ad41/vscode.d.ts#L11221">vscode.d.ts:11221</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Create a diagnostics collection.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> name: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The <a href="../interfaces/vscode.DiagnosticCollection.html#name">name</a> of the collection.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/vscode.DiagnosticCollection.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagnosticCollection</a></h4>
|
|
|
<p>A new diagnostic collection.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerCompletionItemProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Completion<wbr>Item<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Completion<wbr>Item<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.CompletionItemProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CompletionItemProvider</a>, <span class="tsd-signature-symbol">...</span>triggerCharacters<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><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/5f7ad41/vscode.d.ts#L11242">vscode.d.ts:11242</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a completion provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are sorted
|
|
|
by their <a href="vscode.languages.html#match">score</a> and groups of equal score are sequentially asked for
|
|
|
completion items. The process stops when one or many providers of a group return a
|
|
|
result. A failing provider (rejected promise or exception) will not fail the whole
|
|
|
operation.</p>
|
|
|
<p>A completion item provider can be associated with a set of <code>triggerCharacters</code>. When trigger
|
|
|
characters are being typed, completions are requested but only from providers that registered
|
|
|
the typed character. Because of that trigger characters should be different than <a href="../interfaces/vscode.LanguageConfiguration.html#wordPattern">word characters</a>,
|
|
|
a common trigger character is <code>.</code> to trigger member completions.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.CompletionItemProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CompletionItemProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A completion provider.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>triggerCharacters: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Trigger completion when the user types one of the characters.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerCodeActionsProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Code<wbr>Actions<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Code<wbr>Actions<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.CodeActionProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CodeActionProvider</a>, metadata<span class="tsd-signature-symbol">?: </span><a href="../interfaces/vscode.CodeActionProviderMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">CodeActionProviderMetadata</a><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/5f7ad41/vscode.d.ts#L11256">vscode.d.ts:11256</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a code action provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged. A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.CodeActionProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CodeActionProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A code action provider.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> metadata: <a href="../interfaces/vscode.CodeActionProviderMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">CodeActionProviderMetadata</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Metadata about the kind of code actions the provider provides.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerCodeLensProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Code<wbr>Lens<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Code<wbr>Lens<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.CodeLensProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CodeLensProvider</a><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/5f7ad41/vscode.d.ts#L11269">vscode.d.ts:11269</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a code lens provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged. A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.CodeLensProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CodeLensProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A code lens provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerDefinitionProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Definition<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Definition<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.DefinitionProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DefinitionProvider</a><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/5f7ad41/vscode.d.ts#L11282">vscode.d.ts:11282</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a definition provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged. A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.DefinitionProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DefinitionProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A definition provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerImplementationProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Implementation<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Implementation<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.ImplementationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">ImplementationProvider</a><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/5f7ad41/vscode.d.ts#L11295">vscode.d.ts:11295</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register an implementation provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged. A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.ImplementationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">ImplementationProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>An implementation provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerTypeDefinitionProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Type<wbr>Definition<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Type<wbr>Definition<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.TypeDefinitionProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">TypeDefinitionProvider</a><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/5f7ad41/vscode.d.ts#L11308">vscode.d.ts:11308</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a type definition provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged. A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.TypeDefinitionProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">TypeDefinitionProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A type definition provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerDeclarationProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Declaration<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Declaration<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.DeclarationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DeclarationProvider</a><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/5f7ad41/vscode.d.ts#L11321">vscode.d.ts:11321</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a declaration provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged. A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.DeclarationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DeclarationProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A declaration provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerHoverProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Hover<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Hover<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.HoverProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">HoverProvider</a><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/5f7ad41/vscode.d.ts#L11334">vscode.d.ts:11334</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a hover provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged. A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.HoverProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">HoverProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A hover provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerEvaluatableExpressionProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Evaluatable<wbr>Expression<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Evaluatable<wbr>Expression<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.EvaluatableExpressionProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">EvaluatableExpressionProvider</a><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/5f7ad41/vscode.d.ts#L11346">vscode.d.ts:11346</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a provider that locates evaluatable expressions in text documents.
|
|
|
The editor will evaluate the expression in the active debug session and will show the result in the debug hover.</p>
|
|
|
</div>
|
|
|
<p>If multiple providers are registered for a language an arbitrary provider will be used.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.EvaluatableExpressionProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">EvaluatableExpressionProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>An evaluatable expression provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerInlineValuesProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Inline<wbr>Values<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Inline<wbr>Values<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.InlineValuesProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">InlineValuesProvider</a><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/5f7ad41/vscode.d.ts#L11361">vscode.d.ts:11361</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a provider that returns data for the debugger's 'inline value' feature.
|
|
|
Whenever the generic debugger has stopped in a source file, providers registered for the language of the file
|
|
|
are called to return textual data that will be shown in the editor at the end of lines.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged. A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.InlineValuesProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">InlineValuesProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>An inline values provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerDocumentHighlightProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Document<wbr>Highlight<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Document<wbr>Highlight<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.DocumentHighlightProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentHighlightProvider</a><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/5f7ad41/vscode.d.ts#L11374">vscode.d.ts:11374</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a document highlight provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are sorted
|
|
|
by their <a href="vscode.languages.html#match">score</a> and groups sequentially asked for document highlights.
|
|
|
The process stops when a provider returns a <code>non-falsy</code> or <code>non-failure</code> result.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.DocumentHighlightProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentHighlightProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A document highlight provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerDocumentSymbolProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Document<wbr>Symbol<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Document<wbr>Symbol<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.DocumentSymbolProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentSymbolProvider</a>, metaData<span class="tsd-signature-symbol">?: </span><a href="../interfaces/vscode.DocumentSymbolProviderMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentSymbolProviderMetadata</a><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/5f7ad41/vscode.d.ts#L11388">vscode.d.ts:11388</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a document symbol provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged. A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.DocumentSymbolProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentSymbolProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A document symbol provider.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> metaData: <a href="../interfaces/vscode.DocumentSymbolProviderMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentSymbolProviderMetadata</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>metadata about the provider</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerWorkspaceSymbolProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Workspace<wbr>Symbol<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Workspace<wbr>Symbol<wbr>Provider<span class="tsd-signature-symbol">(</span>provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.WorkspaceSymbolProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceSymbolProvider</a><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/5f7ad41/vscode.d.ts#L11400">vscode.d.ts:11400</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a workspace symbol provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered. In that case providers are asked in parallel and
|
|
|
the results are merged. A failing provider (rejected promise or exception) will not cause
|
|
|
a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.WorkspaceSymbolProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceSymbolProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A workspace symbol provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerReferenceProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Reference<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Reference<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.ReferenceProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">ReferenceProvider</a><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/5f7ad41/vscode.d.ts#L11413">vscode.d.ts:11413</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a reference provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged. A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.ReferenceProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">ReferenceProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A reference provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerRenameProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Rename<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Rename<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.RenameProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">RenameProvider</a><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/5f7ad41/vscode.d.ts#L11426">vscode.d.ts:11426</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a rename provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are sorted
|
|
|
by their <a href="vscode.languages.html#match">score</a> and asked in sequence. The first provider producing a result
|
|
|
defines the result of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.RenameProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">RenameProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A rename provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerDocumentSemanticTokensProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Document<wbr>Semantic<wbr>Tokens<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Document<wbr>Semantic<wbr>Tokens<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.DocumentSemanticTokensProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentSemanticTokensProvider</a>, legend<span class="tsd-signature-symbol">: </span><a href="../classes/vscode.SemanticTokensLegend.html" class="tsd-signature-type" data-tsd-kind="Class">SemanticTokensLegend</a><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/5f7ad41/vscode.d.ts#L11439">vscode.d.ts:11439</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a semantic tokens provider for a whole document.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are sorted
|
|
|
by their <a href="vscode.languages.html#match">score</a> and the best-matching provider is used. Failure
|
|
|
of the selected provider will cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.DocumentSemanticTokensProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentSemanticTokensProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A document semantic tokens provider.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>legend: <a href="../classes/vscode.SemanticTokensLegend.html" class="tsd-signature-type" data-tsd-kind="Class">SemanticTokensLegend</a></h5>
|
|
|
</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerDocumentRangeSemanticTokensProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Document<wbr>Range<wbr>Semantic<wbr>Tokens<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Document<wbr>Range<wbr>Semantic<wbr>Tokens<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.DocumentRangeSemanticTokensProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentRangeSemanticTokensProvider</a>, legend<span class="tsd-signature-symbol">: </span><a href="../classes/vscode.SemanticTokensLegend.html" class="tsd-signature-type" data-tsd-kind="Class">SemanticTokensLegend</a><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/5f7ad41/vscode.d.ts#L11458">vscode.d.ts:11458</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a semantic tokens provider for a document range.</p>
|
|
|
</div>
|
|
|
<p><em>Note:</em> If a document has both a <code>DocumentSemanticTokensProvider</code> and a <code>DocumentRangeSemanticTokensProvider</code>,
|
|
|
the range provider will be invoked only initially, for the time in which the full document provider takes
|
|
|
to resolve the first request. Once the full document provider resolves the first request, the semantic tokens
|
|
|
provided via the range provider will be discarded and from that point forward, only the document provider
|
|
|
will be used.</p>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are sorted
|
|
|
by their <a href="vscode.languages.html#match">score</a> and the best-matching provider is used. Failure
|
|
|
of the selected provider will cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.DocumentRangeSemanticTokensProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentRangeSemanticTokensProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A document range semantic tokens provider.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>legend: <a href="../classes/vscode.SemanticTokensLegend.html" class="tsd-signature-type" data-tsd-kind="Class">SemanticTokensLegend</a></h5>
|
|
|
</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerDocumentFormattingEditProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Document<wbr>Formatting<wbr>Edit<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Document<wbr>Formatting<wbr>Edit<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.DocumentFormattingEditProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentFormattingEditProvider</a><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/5f7ad41/vscode.d.ts#L11471">vscode.d.ts:11471</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a formatting provider for a document.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are sorted
|
|
|
by their <a href="vscode.languages.html#match">score</a> and the best-matching provider is used. Failure
|
|
|
of the selected provider will cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.DocumentFormattingEditProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentFormattingEditProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A document formatting edit provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerDocumentRangeFormattingEditProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Document<wbr>Range<wbr>Formatting<wbr>Edit<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Document<wbr>Range<wbr>Formatting<wbr>Edit<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.DocumentRangeFormattingEditProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentRangeFormattingEditProvider</a><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/5f7ad41/vscode.d.ts#L11488">vscode.d.ts:11488</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a formatting provider for a document range.</p>
|
|
|
</div>
|
|
|
<p><em>Note:</em> A document range provider is also a <a href="../interfaces/vscode.DocumentFormattingEditProvider.html">document formatter</a>
|
|
|
which means there is no need to <a href="vscode.languages.html#registerDocumentFormattingEditProvider">register</a> a document
|
|
|
formatter when also registering a range provider.</p>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are sorted
|
|
|
by their <a href="vscode.languages.html#match">score</a> and the best-matching provider is used. Failure
|
|
|
of the selected provider will cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.DocumentRangeFormattingEditProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentRangeFormattingEditProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A document range formatting edit provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerOnTypeFormattingEditProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>OnType<wbr>Formatting<wbr>Edit<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>OnType<wbr>Formatting<wbr>Edit<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.OnTypeFormattingEditProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">OnTypeFormattingEditProvider</a>, firstTriggerCharacter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>moreTriggerCharacter<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><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/5f7ad41/vscode.d.ts#L11503">vscode.d.ts:11503</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a formatting provider that works on type. The provider is active when the user enables the setting <code>editor.formatOnType</code>.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are sorted
|
|
|
by their <a href="vscode.languages.html#match">score</a> and the best-matching provider is used. Failure
|
|
|
of the selected provider will cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.OnTypeFormattingEditProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">OnTypeFormattingEditProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>An on type formatting edit provider.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>firstTriggerCharacter: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A character on which formatting should be triggered, like <code>}</code>.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>moreTriggerCharacter: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>More trigger characters.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerSignatureHelpProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Signature<wbr>Help<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Signature<wbr>Help<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.SignatureHelpProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">SignatureHelpProvider</a>, <span class="tsd-signature-symbol">...</span>triggerCharacters<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><a href="../classes/vscode.Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Signature<wbr>Help<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.SignatureHelpProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">SignatureHelpProvider</a>, metadata<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.SignatureHelpProviderMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">SignatureHelpProviderMetadata</a><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/5f7ad41/vscode.d.ts#L11518">vscode.d.ts:11518</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a signature help provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are sorted
|
|
|
by their <a href="vscode.languages.html#match">score</a> and called sequentially until a provider returns a
|
|
|
valid result.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.SignatureHelpProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">SignatureHelpProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A signature help provider.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>triggerCharacters: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Trigger signature help when the user types one of the characters, like <code>,</code> or <code>(</code>.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/5f7ad41/vscode.d.ts#L11519">vscode.d.ts:11519</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.SignatureHelpProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">SignatureHelpProvider</a></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>metadata: <a href="../interfaces/vscode.SignatureHelpProviderMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">SignatureHelpProviderMetadata</a></h5>
|
|
|
</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>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerDocumentLinkProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Document<wbr>Link<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Document<wbr>Link<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.DocumentLinkProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentLinkProvider</a><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/5f7ad41/vscode.d.ts#L11532">vscode.d.ts:11532</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a document link provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged. A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.DocumentLinkProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentLinkProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A document link provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerColorProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Color<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Color<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.DocumentColorProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentColorProvider</a><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/5f7ad41/vscode.d.ts#L11545">vscode.d.ts:11545</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a color provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged. A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.DocumentColorProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">DocumentColorProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A color provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerFoldingRangeProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Folding<wbr>Range<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Folding<wbr>Range<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.FoldingRangeProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">FoldingRangeProvider</a><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/5f7ad41/vscode.d.ts#L11562">vscode.d.ts:11562</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a folding range provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged.
|
|
|
If multiple folding ranges start at the same position, only the range of the first registered provider is used.
|
|
|
If a folding range overlaps with an other range that has a smaller position, it is also ignored.</p>
|
|
|
<p>A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.FoldingRangeProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">FoldingRangeProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A folding range provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerSelectionRangeProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Selection<wbr>Range<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Selection<wbr>Range<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.SelectionRangeProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">SelectionRangeProvider</a><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/5f7ad41/vscode.d.ts#L11575">vscode.d.ts:11575</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a selection range provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are asked in
|
|
|
parallel and the results are merged. A failing provider (rejected promise or exception) will
|
|
|
not cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.SelectionRangeProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">SelectionRangeProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selection range provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerCallHierarchyProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Call<wbr>Hierarchy<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Call<wbr>Hierarchy<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.CallHierarchyProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CallHierarchyProvider</a><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/5f7ad41/vscode.d.ts#L11584">vscode.d.ts:11584</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a call hierarchy provider.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.CallHierarchyProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CallHierarchyProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A call hierarchy provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerLinkedEditingRangeProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Linked<wbr>Editing<wbr>Range<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Linked<wbr>Editing<wbr>Range<wbr>Provider<span class="tsd-signature-symbol">(</span>selector<span class="tsd-signature-symbol">: </span><a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.LinkedEditingRangeProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">LinkedEditingRangeProvider</a><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/5f7ad41/vscode.d.ts#L11597">vscode.d.ts:11597</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a linked editing range provider.</p>
|
|
|
</div>
|
|
|
<p>Multiple providers can be registered for a language. In that case providers are sorted
|
|
|
by their <a href="vscode.languages.html#match">score</a> and the best-matching provider that has a result is used. Failure
|
|
|
of the selected provider will cause a failure of the whole operation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>selector: <a href="vscode.html#DocumentSelector" class="tsd-signature-type" data-tsd-kind="Type alias">DocumentSelector</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A selector that defines the documents this provider is applicable to.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/vscode.LinkedEditingRangeProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">LinkedEditingRangeProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A linked editing range provider.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="setLanguageConfiguration" class="tsd-anchor"></a>
|
|
|
<h3>set<wbr>Language<wbr>Configuration</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Language<wbr>Configuration<span class="tsd-signature-symbol">(</span>language<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, configuration<span class="tsd-signature-symbol">: </span><a href="../interfaces/vscode.LanguageConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">LanguageConfiguration</a><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/5f7ad41/vscode.d.ts#L11606">vscode.d.ts:11606</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Set a <a href="../interfaces/vscode.LanguageConfiguration.html">language configuration</a> for a language.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>language: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A language identifier like <code>typescript</code>.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>configuration: <a href="../interfaces/vscode.LanguageConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">LanguageConfiguration</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Language configuration.</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>A <a href="../classes/vscode.Disposable.html">Disposable</a> that unsets this configuration.</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=" 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="current 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.languages.html#getLanguages" class="tsd-kind-icon">get<wbr>Languages</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#setTextDocumentLanguage" class="tsd-kind-icon">set<wbr>Text<wbr>Document<wbr>Language</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#match" class="tsd-kind-icon">match</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#onDidChangeDiagnostics" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Diagnostics</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#getDiagnostics" class="tsd-kind-icon">get<wbr>Diagnostics</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#createDiagnosticCollection" class="tsd-kind-icon">create<wbr>Diagnostic<wbr>Collection</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerCompletionItemProvider" class="tsd-kind-icon">register<wbr>Completion<wbr>Item<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerCodeActionsProvider" class="tsd-kind-icon">register<wbr>Code<wbr>Actions<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerCodeLensProvider" class="tsd-kind-icon">register<wbr>Code<wbr>Lens<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerDefinitionProvider" class="tsd-kind-icon">register<wbr>Definition<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerImplementationProvider" class="tsd-kind-icon">register<wbr>Implementation<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerTypeDefinitionProvider" class="tsd-kind-icon">register<wbr>Type<wbr>Definition<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerDeclarationProvider" class="tsd-kind-icon">register<wbr>Declaration<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerHoverProvider" class="tsd-kind-icon">register<wbr>Hover<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerEvaluatableExpressionProvider" class="tsd-kind-icon">register<wbr>Evaluatable<wbr>Expression<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerInlineValuesProvider" class="tsd-kind-icon">register<wbr>Inline<wbr>Values<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerDocumentHighlightProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Highlight<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerDocumentSymbolProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Symbol<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerWorkspaceSymbolProvider" class="tsd-kind-icon">register<wbr>Workspace<wbr>Symbol<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerReferenceProvider" class="tsd-kind-icon">register<wbr>Reference<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerRenameProvider" class="tsd-kind-icon">register<wbr>Rename<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerDocumentSemanticTokensProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Semantic<wbr>Tokens<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerDocumentRangeSemanticTokensProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Range<wbr>Semantic<wbr>Tokens<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerDocumentFormattingEditProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Formatting<wbr>Edit<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerDocumentRangeFormattingEditProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Range<wbr>Formatting<wbr>Edit<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerOnTypeFormattingEditProvider" class="tsd-kind-icon">register<wbr>OnType<wbr>Formatting<wbr>Edit<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerSignatureHelpProvider" class="tsd-kind-icon">register<wbr>Signature<wbr>Help<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerDocumentLinkProvider" class="tsd-kind-icon">register<wbr>Document<wbr>Link<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerColorProvider" class="tsd-kind-icon">register<wbr>Color<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerFoldingRangeProvider" class="tsd-kind-icon">register<wbr>Folding<wbr>Range<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerSelectionRangeProvider" class="tsd-kind-icon">register<wbr>Selection<wbr>Range<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerCallHierarchyProvider" class="tsd-kind-icon">register<wbr>Call<wbr>Hierarchy<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#registerLinkedEditingRangeProvider" class="tsd-kind-icon">register<wbr>Linked<wbr>Editing<wbr>Range<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="vscode.languages.html#setLanguageConfiguration" class="tsd-kind-icon">set<wbr>Language<wbr>Configuration</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>
|
|
|
<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> |
