You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
vscode-api-cn.js/classes/vscode.WorkspaceEdit.html

738 lines
41 KiB

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>WorkspaceEdit | VS Code API 中文文档</title>
<meta name="description" content="Documentation for VS Code API 中文文档">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="shortcut icon" href="https://code.visualstudio.com/favicon.ico" sizes="128x128">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-7962287588031867" crossorigin="anonymous"></script>
<style>
a[title="站长统计"] {
display: none;
}
.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="../modules/vscode.html">vscode</a>
</li>
<li>
<a href="vscode.WorkspaceEdit.html">WorkspaceEdit</a>
</li>
</ul>
<h1>Class WorkspaceEdit</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>A workspace edit is a collection of textual and files changes for
multiple resources and documents.</p>
</div>
<p>Use the <a href="../modules/vscode.workspace.html#applyEdit">applyEdit</a>-function to apply a workspace edit.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>层级</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">WorkspaceEdit</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>Constructors1</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="vscode.WorkspaceEdit.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties1</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.WorkspaceEdit.html#size" class="tsd-kind-icon">size</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods10</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.WorkspaceEdit.html#replace" class="tsd-kind-icon">replace</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.WorkspaceEdit.html#insert" class="tsd-kind-icon">insert</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.WorkspaceEdit.html#delete" class="tsd-kind-icon">delete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.WorkspaceEdit.html#has" class="tsd-kind-icon">has</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.WorkspaceEdit.html#set" class="tsd-kind-icon">set</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.WorkspaceEdit.html#get" class="tsd-kind-icon">get</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.WorkspaceEdit.html#createFile" class="tsd-kind-icon">create<wbr>File</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.WorkspaceEdit.html#deleteFile" class="tsd-kind-icon">delete<wbr>File</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.WorkspaceEdit.html#renameFile" class="tsd-kind-icon">rename<wbr>File</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="vscode.WorkspaceEdit.html#entries" class="tsd-kind-icon">entries</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors1</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Workspace<wbr>Edit<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.WorkspaceEdit.html" class="tsd-signature-type" data-tsd-kind="Class">WorkspaceEdit</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-returns-title">Returns <a href="vscode.WorkspaceEdit.html" class="tsd-signature-type" data-tsd-kind="Class">WorkspaceEdit</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties1</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="size" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> size</h3>
<div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/fe9f8c2/vscode.d.ts#L3290">vscode.d.ts:3290</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The number of affected resources of textual or resource changes.</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods10</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="replace" class="tsd-anchor"></a>
<h3>replace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">replace<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a>, range<span class="tsd-signature-symbol">: </span><a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a>, newText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, metadata<span class="tsd-signature-symbol">?: </span><a href="../interfaces/vscode.WorkspaceEditEntryMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceEditEntryMetadata</a><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/vscode-cn/vscode-api-cn/blob/fe9f8c2/vscode.d.ts#L3300">vscode.d.ts:3300</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Replace the given range with given text for the given resource.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
<div class="tsd-comment tsd-typography">
<p>A resource identifier.</p>
</div>
</li>
<li>
<h5>range: <a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a></h5>
<div class="tsd-comment tsd-typography">
<p>A range.</p>
</div>
</li>
<li>
<h5>newText: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A string.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> metadata: <a href="../interfaces/vscode.WorkspaceEditEntryMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceEditEntryMetadata</a></h5>
<div class="tsd-comment tsd-typography">
<p>Optional metadata for the entry.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="insert" class="tsd-anchor"></a>
<h3>insert</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">insert<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a>, position<span class="tsd-signature-symbol">: </span><a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a>, newText<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, metadata<span class="tsd-signature-symbol">?: </span><a href="../interfaces/vscode.WorkspaceEditEntryMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceEditEntryMetadata</a><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/vscode-cn/vscode-api-cn/blob/fe9f8c2/vscode.d.ts#L3310">vscode.d.ts:3310</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Insert the given text at the given position.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
<div class="tsd-comment tsd-typography">
<p>A resource identifier.</p>
</div>
</li>
<li>
<h5>position: <a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></h5>
<div class="tsd-comment tsd-typography">
<p>A position.</p>
</div>
</li>
<li>
<h5>newText: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A string.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> metadata: <a href="../interfaces/vscode.WorkspaceEditEntryMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceEditEntryMetadata</a></h5>
<div class="tsd-comment tsd-typography">
<p>Optional metadata for the entry.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="delete" class="tsd-anchor"></a>
<h3>delete</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a>, range<span class="tsd-signature-symbol">: </span><a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a>, metadata<span class="tsd-signature-symbol">?: </span><a href="../interfaces/vscode.WorkspaceEditEntryMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceEditEntryMetadata</a><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/vscode-cn/vscode-api-cn/blob/fe9f8c2/vscode.d.ts#L3319">vscode.d.ts:3319</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Delete the text at the given range.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
<div class="tsd-comment tsd-typography">
<p>A resource identifier.</p>
</div>
</li>
<li>
<h5>range: <a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a></h5>
<div class="tsd-comment tsd-typography">
<p>A range.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> metadata: <a href="../interfaces/vscode.WorkspaceEditEntryMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceEditEntryMetadata</a></h5>
<div class="tsd-comment tsd-typography">
<p>Optional metadata for the entry.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="has" class="tsd-anchor"></a>
<h3>has</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">has<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><a href="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><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/fe9f8c2/vscode.d.ts#L3327">vscode.d.ts:3327</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if a text edit for a resource exists.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
<div class="tsd-comment tsd-typography">
<p>A resource identifier.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p><code>true</code> if the given resource will be touched by this edit.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="set" class="tsd-anchor"></a>
<h3>set</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a>, edits<span class="tsd-signature-symbol">: </span><a href="vscode.TextEdit.html" class="tsd-signature-type" data-tsd-kind="Class">TextEdit</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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/fe9f8c2/vscode.d.ts#L3335">vscode.d.ts:3335</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set (and replace) text edits for a resource.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
<div class="tsd-comment tsd-typography">
<p>A resource identifier.</p>
</div>
</li>
<li>
<h5>edits: <a href="vscode.TextEdit.html" class="tsd-signature-type" data-tsd-kind="Class">TextEdit</a><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>An array of text edits.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="get" class="tsd-anchor"></a>
<h3>get</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><a href="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="vscode.TextEdit.html" class="tsd-signature-type" data-tsd-kind="Class">TextEdit</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/vscode-cn/vscode-api-cn/blob/fe9f8c2/vscode.d.ts#L3343">vscode.d.ts:3343</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the text edits for a resource.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
<div class="tsd-comment tsd-typography">
<p>A resource identifier.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="vscode.TextEdit.html" class="tsd-signature-type" data-tsd-kind="Class">TextEdit</a><span class="tsd-signature-symbol">[]</span></h4>
<p>An array of text edits.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="createFile" class="tsd-anchor"></a>
<h3>create<wbr>File</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>File<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>overwrite<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>ignoreIfExists<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span>, metadata<span class="tsd-signature-symbol">?: </span><a href="../interfaces/vscode.WorkspaceEditEntryMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceEditEntryMetadata</a><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/vscode-cn/vscode-api-cn/blob/fe9f8c2/vscode.d.ts#L3355">vscode.d.ts:3355</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create a regular file.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
<div class="tsd-comment tsd-typography">
<p>Uri of the new file..</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>overwrite<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>ignoreIfExists<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Defines if an existing file should be overwritten or be
ignored. When overwrite and ignoreIfExists are both set overwrite wins.
When both are unset and when the file already exists then the edit cannot
be applied successfully.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> overwrite<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr>IfExists<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> metadata: <a href="../interfaces/vscode.WorkspaceEditEntryMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceEditEntryMetadata</a></h5>
<div class="tsd-comment tsd-typography">
<p>Optional metadata for the entry.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="deleteFile" class="tsd-anchor"></a>
<h3>delete<wbr>File</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">delete<wbr>File<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>recursive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>ignoreIfNotExists<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span>, metadata<span class="tsd-signature-symbol">?: </span><a href="../interfaces/vscode.WorkspaceEditEntryMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceEditEntryMetadata</a><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/vscode-cn/vscode-api-cn/blob/fe9f8c2/vscode.d.ts#L3363">vscode.d.ts:3363</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Delete a file or folder.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uri: <a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
<div class="tsd-comment tsd-typography">
<p>The uri of the file that is to be deleted.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>recursive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>ignoreIfNotExists<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> recursive<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr>IfNot<wbr>Exists<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> metadata: <a href="../interfaces/vscode.WorkspaceEditEntryMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceEditEntryMetadata</a></h5>
<div class="tsd-comment tsd-typography">
<p>Optional metadata for the entry.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="renameFile" class="tsd-anchor"></a>
<h3>rename<wbr>File</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">rename<wbr>File<span class="tsd-signature-symbol">(</span>oldUri<span class="tsd-signature-symbol">: </span><a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a>, newUri<span class="tsd-signature-symbol">: </span><a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>overwrite<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>ignoreIfExists<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span>, metadata<span class="tsd-signature-symbol">?: </span><a href="../interfaces/vscode.WorkspaceEditEntryMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceEditEntryMetadata</a><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/vscode-cn/vscode-api-cn/blob/fe9f8c2/vscode.d.ts#L3374">vscode.d.ts:3374</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Rename a file or folder.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>oldUri: <a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
<div class="tsd-comment tsd-typography">
<p>The existing file.</p>
</div>
</li>
<li>
<h5>newUri: <a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
<div class="tsd-comment tsd-typography">
<p>The new location.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>overwrite<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>ignoreIfExists<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Defines if existing files should be overwritten or be
ignored. When overwrite and ignoreIfExists are both set overwrite wins.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> overwrite<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr>IfExists<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> metadata: <a href="../interfaces/vscode.WorkspaceEditEntryMetadata.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceEditEntryMetadata</a></h5>
<div class="tsd-comment tsd-typography">
<p>Optional metadata for the entry.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="entries" class="tsd-anchor"></a>
<h3>entries</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">entries<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="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol">, </span><a href="vscode.TextEdit.html" class="tsd-signature-type" data-tsd-kind="Class">TextEdit</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/vscode-cn/vscode-api-cn/blob/fe9f8c2/vscode.d.ts#L3381">vscode.d.ts:3381</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get all text edits grouped by resource.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol">, </span><a href="vscode.TextEdit.html" class="tsd-signature-type" data-tsd-kind="Class">TextEdit</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span></h4>
<p>A shallow copy of <code>[Uri, TextEdit[]]</code>-tuples.</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/vscode.html">vscode</a>
<ul>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/vscode.authentication.html">authentication</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/vscode.commands.html">commands</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/vscode.comments.html">comments</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/vscode.debug.html">debug</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/vscode.env.html">env</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/vscode.extensions.html">extensions</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/vscode.languages.html">languages</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/vscode.notebooks.html">notebooks</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/vscode.scm.html">scm</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/vscode.tasks.html">tasks</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/vscode.tests.html">tests</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/vscode.window.html">window</a>
</li>
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
<a href="../modules/vscode.workspace.html">workspace</a>
</li>
</ul>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-namespace">
<a href="vscode.WorkspaceEdit.html" class="tsd-kind-icon">Workspace<wbr>Edit</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="vscode.WorkspaceEdit.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="vscode.WorkspaceEdit.html#size" class="tsd-kind-icon">size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="vscode.WorkspaceEdit.html#replace" class="tsd-kind-icon">replace</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="vscode.WorkspaceEdit.html#insert" class="tsd-kind-icon">insert</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="vscode.WorkspaceEdit.html#delete" class="tsd-kind-icon">delete</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="vscode.WorkspaceEdit.html#has" class="tsd-kind-icon">has</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="vscode.WorkspaceEdit.html#set" class="tsd-kind-icon">set</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="vscode.WorkspaceEdit.html#get" class="tsd-kind-icon">get</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="vscode.WorkspaceEdit.html#createFile" class="tsd-kind-icon">create<wbr>File</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="vscode.WorkspaceEdit.html#deleteFile" class="tsd-kind-icon">delete<wbr>File</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="vscode.WorkspaceEdit.html#renameFile" class="tsd-kind-icon">rename<wbr>File</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="vscode.WorkspaceEdit.html#entries" class="tsd-kind-icon">entries</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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><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>
<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>