|
|
|
|
<!doctype html>
|
|
|
|
|
<html class="default no-js">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
|
|
<title>FileWillDeleteEvent | VS Code API 中文文档</title>
|
|
|
|
|
<meta name="description" content="VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API。这个站点列出了扩展开发者可以使用的所有 vscode api 中文文档。">
|
|
|
|
|
<meta property="og:site_name" content="Vscode Api 中文文档">
|
|
|
|
|
<meta property="og:type" content="docs">
|
|
|
|
|
<meta property="og:url" content="https://vscode-api-cn.js.org/index.html">
|
|
|
|
|
<meta property="article:tag" content="vscode">
|
|
|
|
|
<meta property="article:tag" content="vscode api">
|
|
|
|
|
<meta property="article:tag" content="vscode api 中文文档">
|
|
|
|
|
<meta property="article:tag" content="vscode api 文档">
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
|
|
<link rel="shortcut icon" href="https://code.visualstudio.com/favicon.ico" sizes="128x128">
|
|
|
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
|
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
|
|
|
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-4070818774984451" crossorigin="anonymous"></script>
|
|
|
|
|
<meta name="monetag" content="eb1e3d5247d1754d0fd449f7b99b110d">
|
|
|
|
|
<meta name="a.validate.02" content="FfmmKD6EanKVetA49MTlFFi-untsfhnAgRiw" />
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
(function (c, l, a, r, i, t, y) {
|
|
|
|
|
c[a] = c[a] || function () { (c[a].q = c[a].q || []).push(arguments) };
|
|
|
|
|
t = l.createElement(r); t.async = 1; t.src = "https://www.clarity.ms/tag/" + i;
|
|
|
|
|
y = l.getElementsByTagName(r)[0]; y.parentNode.insertBefore(t, y);
|
|
|
|
|
})(window, document, "clarity", "script", "g1cbw4nxoq");
|
|
|
|
|
</script>
|
|
|
|
|
<!-- Google tag (gtag.js) -->
|
|
|
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-T4TRRS1LB1"></script>
|
|
|
|
|
<script>
|
|
|
|
|
window.dataLayer = window.dataLayer || [];
|
|
|
|
|
function gtag(){dataLayer.push(arguments);}
|
|
|
|
|
gtag('js', new Date());
|
|
|
|
|
|
|
|
|
|
gtag('config', 'G-T4TRRS1LB1');
|
|
|
|
|
</script>
|
|
|
|
|
<style>
|
|
|
|
|
.container-main {
|
|
|
|
|
padding-bottom: 50px;
|
|
|
|
|
}
|
|
|
|
|
</style>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<header>
|
|
|
|
|
<div class="tsd-page-toolbar">
|
|
|
|
|
<div class="container">
|
|
|
|
|
<div class="table-wrap">
|
|
|
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
|
|
|
<div class="field">
|
|
|
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
|
|
|
<input id="tsd-search-field" type="text" />
|
|
|
|
|
</div>
|
|
|
|
|
<ul class="results">
|
|
|
|
|
<li class="state loading">Preparing search index...</li>
|
|
|
|
|
<li class="state failure">The search index is not available</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<a href="../index.html" class="title">VS Code API 中文文档</a>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="table-cell" id="tsd-widgets">
|
|
|
|
|
<div id="tsd-filter">
|
|
|
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
|
|
|
<div class="tsd-filter-group">
|
|
|
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
|
|
|
<span class="tsd-select-label">All</span>
|
|
|
|
|
<ul class="tsd-select-list">
|
|
|
|
|
<li data-value="public">Public</li>
|
|
|
|
|
<li data-value="protected">Public/Protected</li>
|
|
|
|
|
<li data-value="private" class="selected">All</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
|
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
|
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
|
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="tsd-page-title">
|
|
|
|
|
<div class="container">
|
|
|
|
|
<ul class="tsd-breadcrumb">
|
|
|
|
|
<li>
|
|
|
|
|
<a href="../modules.html">VS Code API 中文文档</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<a href="../modules/vscode.html">vscode</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<a href="vscode.FileWillDeleteEvent.html">FileWillDeleteEvent</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h1>Interface FileWillDeleteEvent</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>An event that is fired when files are going to be deleted.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<p>To make modifications to the workspace before the files are deleted,
|
|
|
|
|
call the <a href="vscode.FileWillCreateEvent.html#waitUntil">`waitUntil</a>-function with a
|
|
|
|
|
thenable that resolves to a <a href="../classes/vscode.WorkspaceEdit.html">workspace edit</a>.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
|
|
|
<h3>层级</h3>
|
|
|
|
|
<ul class="tsd-hierarchy">
|
|
|
|
|
<li>
|
|
|
|
|
<span class="target">FileWillDeleteEvent</span>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
|
|
|
<h2>索引</h2>
|
|
|
|
|
<section class="tsd-panel tsd-index-panel">
|
|
|
|
|
<div class="tsd-index-content">
|
|
|
|
|
<section class="tsd-index-section ">
|
|
|
|
|
<h3>Properties(1)</h3>
|
|
|
|
|
<ul class="tsd-index-list">
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="vscode.FileWillDeleteEvent.html#files" class="tsd-kind-icon">files</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-index-section ">
|
|
|
|
|
<h3>Methods(1)</h3>
|
|
|
|
|
<ul class="tsd-index-list">
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="vscode.FileWillDeleteEvent.html#waitUntil" class="tsd-kind-icon">wait<wbr>Until</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
|
|
<h2>Properties(1)</h2>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a name="files" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> files</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">files<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><a href="../classes/vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol">[]</span></div>
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/2404697/vscode.d.ts#L10423">vscode.d.ts:10423</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>The files that are going to be deleted.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
|
|
<h2>Methods(1)</h2>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
|
|
|
<a name="waitUntil" class="tsd-anchor"></a>
|
|
|
|
|
<h3>wait<wbr>Until</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">wait<wbr>Until<span class="tsd-signature-symbol">(</span>thenable<span class="tsd-signature-symbol">: </span><a href="Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../classes/vscode.WorkspaceEdit.html" class="tsd-signature-type" data-tsd-kind="Class">WorkspaceEdit</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">wait<wbr>Until<span class="tsd-signature-symbol">(</span>thenable<span class="tsd-signature-symbol">: </span><a href="Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/2404697/vscode.d.ts#L10443">vscode.d.ts:10443</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Allows to pause the event and to apply a <a href="../classes/vscode.WorkspaceEdit.html">workspace edit</a>.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<p><em>Note:</em> This function can only be called during event dispatch and not
|
|
|
|
|
in an asynchronous manner:</p>
|
|
|
|
|
<pre><code class="language-ts"><span style="color: #001080">workspace</span><span style="color: #000000">.</span><span style="color: #795E26">onWillCreateFiles</span><span style="color: #000000">(</span><span style="color: #001080">event</span><span style="color: #000000"> </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
|
|
|
<span style="color: #000000"> </span><span style="color: #008000">// async, will *throw* an error</span>
|
|
|
|
|
<span style="color: #000000"> </span><span style="color: #795E26">setTimeout</span><span style="color: #000000">(() </span><span style="color: #0000FF">=></span><span style="color: #000000"> </span><span style="color: #001080">event</span><span style="color: #000000">.</span><span style="color: #795E26">waitUntil</span><span style="color: #000000">(</span><span style="color: #001080">promise</span><span style="color: #000000">));</span>
|
|
|
|
|
|
|
|
|
|
<span style="color: #000000"> </span><span style="color: #008000">// sync, OK</span>
|
|
|
|
|
<span style="color: #000000"> </span><span style="color: #001080">event</span><span style="color: #000000">.</span><span style="color: #795E26">waitUntil</span><span style="color: #000000">(</span><span style="color: #001080">promise</span><span style="color: #000000">);</span>
|
|
|
|
|
<span style="color: #000000">})</span>
|
|
|
|
|
</code></pre>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>thenable: <a href="Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../classes/vscode.WorkspaceEdit.html" class="tsd-signature-type" data-tsd-kind="Class">WorkspaceEdit</a><span class="tsd-signature-symbol">></span></h5>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<p>A thenable that delays saving.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/2404697/vscode.d.ts#L10452">vscode.d.ts:10452</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Allows to pause the event until the provided thenable resolves.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<p><em>Note:</em> This function can only be called during event dispatch.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>thenable: <a href="Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<p>A thenable that delays saving.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
|
|
|
<nav class="tsd-navigation primary">
|
|
|
|
|
<ul>
|
|
|
|
|
<li class=" ">
|
|
|
|
|
<a href="../modules.html">Exports</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="current tsd-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.html">vscode</a>
|
|
|
|
|
<ul>
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.authentication.html">authentication</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.commands.html">commands</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.comments.html">comments</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.debug.html">debug</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.env.html">env</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.extensions.html">extensions</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.languages.html">languages</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.notebooks.html">notebooks</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.scm.html">scm</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.tasks.html">tasks</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.tests.html">tests</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.window.html">window</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
|
|
<a href="../modules/vscode.workspace.html">workspace</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</nav>
|
|
|
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
|
|
|
<div style="width: 200px">
|
|
|
|
|
<script type="text/javascript" id="clstr_globe" src="//clustrmaps.com/globe.js?d=cMnk-gSDNcAzNMMm67U8rWRaHnjUc0Xb0giSGndepK4"></script>
|
|
|
|
|
</div>
|
|
|
|
|
<ul class="before-current">
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="current">
|
|
|
|
|
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
|
|
|
|
|
<a href="vscode.FileWillDeleteEvent.html" class="tsd-kind-icon">File<wbr>Will<wbr>Delete<wbr>Event</a>
|
|
|
|
|
<ul>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="vscode.FileWillDeleteEvent.html#files" class="tsd-kind-icon">files</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
|
|
|
<a href="vscode.FileWillDeleteEvent.html#waitUntil" class="tsd-kind-icon">wait<wbr>Until</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="after-current">
|
|
|
|
|
</ul>
|
|
|
|
|
</nav>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<footer class="with-border-bottom">
|
|
|
|
|
<div class="container">
|
|
|
|
|
<h2>图例</h2>
|
|
|
|
|
<div class="tsd-legend-group">
|
|
|
|
|
<ul class="tsd-legend">
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</footer>
|
|
|
|
|
<div class="container tsd-generator">
|
|
|
|
|
<p><a href="https://liiked.github.io/VS-Code-Extension-Doc-ZH/" target="_blank">VS Code 插件开发中文文档</a> | <a href="https://jeasonstudio.gitbooks.io/vscode-cn-doc/content/" target="_blank">VS Code 中文文档</a> | <a href="https://code.visualstudio.com/docs" target="_blank">VS Code 官网文档</a> | <a href="https://marketplace.visualstudio.com/" target="_blank">VS Code 扩展市场</a></p>
|
|
|
|
|
<p>Generated by <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="overlay"></div>
|
|
|
|
|
<script src="../assets/js/main.js"></script>
|
|
|
|
|
<script>(function (d, z, s) { s.src = 'https://' + d + '/400/' + z; try { (document.body || document.documentElement).appendChild(s) } catch (e) { } })('offfurreton.com', 5772070, document.createElement('script'))</script>
|
|
|
|
|
<script data-cfasync="false" type="text/javascript" src="//predictiondisplay.com/a/display.php?r=6814154"></script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|