<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > FileSystemProvider | 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 = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< / 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 = "../index.html" > VS Code API 中文文档< / a >
< / li >
< li >
< a href = "FileSystemProvider.html" > FileSystemProvider< / a >
< / li >
< / ul >
< h1 > Interface FileSystemProvider< / 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 > The filesystem provider defines what the editor needs to read, write, discover,
and to manage files and folders. It allows extensions to serve files from remote places,
like ftp-servers, and to seamlessly integrate those into the editor.< / p >
< / div >
< ul >
< li > < em > Note 1:< / em > The filesystem provider API works with < a href = "../classes/Uri.html" > uris< / a > and assumes hierarchical
paths, e.g. < code > foo:/my/path< / code > is a child of < code > foo:/my/< / code > and a parent of < code > foo:/my/path/deeper< / code > .< / li >
< li > < em > Note 2:< / em > There is an activation event < code > onFileSystem:< scheme> < / code > that fires when a file
or folder is being accessed.< / li >
< li > < em > Note 3:< / em > The word ' file' is often used to denote all < a href = "../enums/FileType.html" > kinds< / a > of files, e.g.
folders, symbolic links, and regular files.< / li >
< / ul >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > FileSystemProvider< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > 索引< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Properties< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "FileSystemProvider.html#onDidChangeFile" class = "tsd-kind-icon" > on< wbr > Did< wbr > Change< wbr > File< / a > < / li >
< / ul >
< / section >
< section class = "tsd-index-section " >
< h3 > Methods< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "FileSystemProvider.html#watch" class = "tsd-kind-icon" > watch< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "FileSystemProvider.html#stat" class = "tsd-kind-icon" > stat< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "FileSystemProvider.html#readDirectory" class = "tsd-kind-icon" > read< wbr > Directory< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "FileSystemProvider.html#createDirectory" class = "tsd-kind-icon" > create< wbr > Directory< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "FileSystemProvider.html#readFile" class = "tsd-kind-icon" > read< wbr > File< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "FileSystemProvider.html#writeFile" class = "tsd-kind-icon" > write< wbr > File< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "FileSystemProvider.html#delete" class = "tsd-kind-icon" > delete< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "FileSystemProvider.html#rename" class = "tsd-kind-icon" > rename< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "FileSystemProvider.html#copy" class = "tsd-kind-icon" > copy< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Properties< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "onDidChangeFile" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > on< wbr > Did< wbr > Change< wbr > File< / h3 >
< div class = "tsd-signature tsd-kind-icon" > on< wbr > Did< wbr > Change< wbr > File< span class = "tsd-signature-symbol" > :< / span > < a href = "Event.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Event< / a > < span class = "tsd-signature-symbol" > < < / span > < a href = "FileChangeEvent.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > FileChangeEvent< / a > < span class = "tsd-signature-symbol" > []< / span > < 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/92ff2a4/vscode.d.ts#L7171" > vscode.d.ts:7171< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > An event to signal that a resource has been created, changed, or deleted. This
event should fire for resources that are being < a href = "FileSystemProvider.html#watch" > watched< / a >
by clients of this provider.< / p >
< / div >
< p > < em > Note:< / em > It is important that the metadata of the file that changed provides an
updated < code > mtime< / code > that advanced from the previous value in the < a href = "FileStat.html" > stat< / a > and a
correct < code > size< / code > value. Otherwise there may be optimizations in place that will not show
the change in an editor for example.< / p >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Methods< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "watch" class = "tsd-anchor" > < / a >
< h3 > watch< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > watch< span class = "tsd-signature-symbol" > (< / span > uri< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/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 > excludes< 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 > < span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/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/92ff2a4/vscode.d.ts#L7184" > vscode.d.ts:7184< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Subscribe to events in the file or folder denoted by < code > uri< / code > .< / p >
< / div >
< p > The editor will call this function for files and folders. In the latter case, the
options differ from defaults, e.g. what files/folders to exclude from watching
and if subfolders, sub-subfolder, etc. should be watched (< code > recursive< / code > ).< / p >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > uri: < a href = "../classes/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 to be watched.< / p >
< / div >
< / li >
< li >
< h5 > 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 > excludes< 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 > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Configures the watch.< / p >
< / div >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > recursive< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > excludes< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 >
< / li >
< / ul >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../classes/Disposable.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Disposable< / a > < / h4 >
< p > A disposable that tells the provider to stop watching the < code > uri< / code > .< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "stat" class = "tsd-anchor" > < / a >
< h3 > stat< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > stat< span class = "tsd-signature-symbol" > (< / span > uri< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/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 = "FileStat.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > FileStat< / a > < 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 = "FileStat.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > FileStat< / 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/92ff2a4/vscode.d.ts#L7197" > vscode.d.ts:7197< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Retrieve metadata about a file.< / p >
< / div >
< p > Note that the metadata for symbolic links should be the metadata of the file they refer to.
Still, the < a href = "../enums/FileType.html#SymbolicLink" > SymbolicLink< / a > -type must be used in addition to the actual type, e.g.
< code > FileType.SymbolicLink | FileType.Directory< / code > .< / p >
< dl class = "tsd-comment-tags" >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileNotFound" > < code > FileNotFound< / code > < / a > when < code > uri< / code > doesn' t exist.< / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > uri: < a href = "../classes/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 to retrieve metadata about.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "FileStat.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > FileStat< / a > < 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 = "FileStat.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > FileStat< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< p > The file metadata about the file.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "readDirectory" class = "tsd-anchor" > < / a >
< h3 > read< wbr > Directory< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > read< wbr > Directory< span class = "tsd-signature-symbol" > (< / span > uri< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/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-symbol" > [< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > , < / span > < a href = "../enums/FileType.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > FileType< / a > < span class = "tsd-signature-symbol" > ]< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-symbol" > [< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > , < / span > < a href = "../enums/FileType.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > FileType< / 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/92ff2a4/vscode.d.ts#L7206" > vscode.d.ts:7206< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Retrieve all entries of a < a href = "../enums/FileType.html#Directory" > directory< / a > .< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileNotFound" > < code > FileNotFound< / code > < / a > when < code > uri< / code > doesn' t exist.< / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > uri: < a href = "../classes/Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The uri of the folder.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-symbol" > [< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > , < / span > < a href = "../enums/FileType.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > FileType< / a > < span class = "tsd-signature-symbol" > ]< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-symbol" > [< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > , < / span > < a href = "../enums/FileType.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > FileType< / a > < span class = "tsd-signature-symbol" > ]< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< p > An array of name/type-tuples or a thenable that resolves to such.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "createDirectory" class = "tsd-anchor" > < / a >
< h3 > create< wbr > Directory< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > create< wbr > Directory< span class = "tsd-signature-symbol" > (< / span > uri< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/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" > void< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / 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/92ff2a4/vscode.d.ts#L7216" > vscode.d.ts:7216< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Create a new directory (Note, that new files are created via < code > write< / code > -calls).< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileNotFound" > < code > FileNotFound< / code > < / a > when the parent of < code > uri< / code > doesn' t exist, e.g. no mkdirp-logic required.< / p >
< / dd >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileExists" > < code > FileExists< / code > < / a > when < code > uri< / code > already exists.< / p >
< / dd >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#NoPermissions" > < code > NoPermissions< / code > < / a > when permissions aren' t sufficient.< / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > uri: < a href = "../classes/Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The uri of the new folder.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "readFile" class = "tsd-anchor" > < / a >
< h3 > read< wbr > File< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > read< wbr > File< span class = "tsd-signature-symbol" > (< / span > uri< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/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" > Uint8Array< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Uint8Array< / 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/92ff2a4/vscode.d.ts#L7225" > vscode.d.ts:7225< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Read the entire contents of a file.< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileNotFound" > < code > FileNotFound< / code > < / a > when < code > uri< / code > doesn' t exist.< / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > uri: < a href = "../classes/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.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Uint8Array< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > Uint8Array< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< p > An array of bytes or a thenable that resolves to such.< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "writeFile" class = "tsd-anchor" > < / a >
< h3 > write< wbr > File< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > write< wbr > File< span class = "tsd-signature-symbol" > (< / span > uri< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > , content< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Uint8Array< / span > , options< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > { < / span > create< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / 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 > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / 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/92ff2a4/vscode.d.ts#L7238" > vscode.d.ts:7238< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Write data to a file, replacing its entire contents.< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileNotFound" > < code > FileNotFound< / code > < / a > when < code > uri< / code > doesn' t exist and < code > create< / code > is not set.< / p >
< / dd >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileNotFound" > < code > FileNotFound< / code > < / a > when the parent of < code > uri< / code > doesn' t exist and < code > create< / code > is set, e.g. no mkdirp-logic required.< / p >
< / dd >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileExists" > < code > FileExists< / code > < / a > when < code > uri< / code > already exists, < code > create< / code > is set but < code > overwrite< / code > is not set.< / p >
< / dd >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#NoPermissions" > < code > NoPermissions< / code > < / a > when permissions aren' t sufficient.< / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > uri: < a href = "../classes/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.< / p >
< / div >
< / li >
< li >
< h5 > content: < span class = "tsd-signature-type" > Uint8Array< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The new content of the file.< / p >
< / div >
< / li >
< li >
< h5 > options: < span class = "tsd-signature-symbol" > { < / span > create< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / 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 > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Defines if missing files should or must be created.< / p >
< / div >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > create< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< li class = "tsd-parameter" >
< h5 > overwrite< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< / ul >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "delete" class = "tsd-anchor" > < / a >
< h3 > delete< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > delete< span class = "tsd-signature-symbol" > (< / span > uri< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/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 > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / 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/92ff2a4/vscode.d.ts#L7248" > vscode.d.ts:7248< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Delete a file.< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileNotFound" > < code > FileNotFound< / code > < / a > when < code > uri< / code > doesn' t exist.< / p >
< / dd >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#NoPermissions" > < code > NoPermissions< / code > < / a > when permissions aren' t sufficient.< / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > uri: < a href = "../classes/Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The resource that is to be deleted.< / p >
< / div >
< / li >
< li >
< h5 > 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 > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Defines if deletion of folders is recursive.< / p >
< / div >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > recursive< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< / ul >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "rename" class = "tsd-anchor" > < / a >
< h3 > rename< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > rename< span class = "tsd-signature-symbol" > (< / span > oldUri< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > , newUri< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/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 > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / 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/92ff2a4/vscode.d.ts#L7261" > vscode.d.ts:7261< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Rename a file or folder.< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileNotFound" > < code > FileNotFound< / code > < / a > when < code > oldUri< / code > doesn' t exist.< / p >
< / dd >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileNotFound" > < code > FileNotFound< / code > < / a > when parent of < code > newUri< / code > doesn' t exist, e.g. no mkdirp-logic required.< / p >
< / dd >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileExists" > < code > FileExists< / code > < / a > when < code > newUri< / code > exists and when the < code > overwrite< / code > option is not < code > true< / code > .< / p >
< / dd >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#NoPermissions" > < code > NoPermissions< / code > < / a > when permissions aren' t sufficient.< / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > oldUri: < a href = "../classes/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 = "../classes/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 > 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 > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Defines if existing files should be overwritten.< / p >
< / div >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > overwrite< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< / ul >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "copy" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > copy< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > copy< span class = "tsd-signature-symbol" > (< / span > source< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > , destination< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/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 > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / 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/92ff2a4/vscode.d.ts#L7275" > vscode.d.ts:7275< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Copy files or folders. Implementing this function is optional but it will speedup
the copy operation.< / p >
< / div >
< dl class = "tsd-comment-tags" >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileNotFound" > < code > FileNotFound< / code > < / a > when < code > source< / code > doesn' t exist.< / p >
< / dd >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileNotFound" > < code > FileNotFound< / code > < / a > when parent of < code > destination< / code > doesn' t exist, e.g. no mkdirp-logic required.< / p >
< / dd >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#FileExists" > < code > FileExists< / code > < / a > when < code > destination< / code > exists and when the < code > overwrite< / code > option is not < code > true< / code > .< / p >
< / dd >
< dt > throws< / dt >
< dd > < p > < a href = "../classes/FileSystemError.html#NoPermissions" > < code > NoPermissions< / code > < / a > when permissions aren' t sufficient.< / p >
< / dd >
< / dl >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > source: < a href = "../classes/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 > destination: < a href = "../classes/Uri.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Uri< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The destination location.< / p >
< / div >
< / li >
< li >
< h5 > 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 > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Defines if existing files should be overwritten.< / p >
< / div >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter" >
< h5 > overwrite< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< / ul >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "Thenable.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > Thenable< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / 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 = "../index.html" > Exports< / a >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-interface" >
< a href = "FileSystemProvider.html" class = "tsd-kind-icon" > File< wbr > System< wbr > Provider< / a >
< ul >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "FileSystemProvider.html#onDidChangeFile" class = "tsd-kind-icon" > on< wbr > Did< wbr > Change< wbr > File< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "FileSystemProvider.html#watch" class = "tsd-kind-icon" > watch< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "FileSystemProvider.html#stat" class = "tsd-kind-icon" > stat< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "FileSystemProvider.html#readDirectory" class = "tsd-kind-icon" > read< wbr > Directory< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "FileSystemProvider.html#createDirectory" class = "tsd-kind-icon" > create< wbr > Directory< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "FileSystemProvider.html#readFile" class = "tsd-kind-icon" > read< wbr > File< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "FileSystemProvider.html#writeFile" class = "tsd-kind-icon" > write< wbr > File< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "FileSystemProvider.html#delete" class = "tsd-kind-icon" > delete< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "FileSystemProvider.html#rename" class = "tsd-kind-icon" > rename< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "FileSystemProvider.html#copy" class = "tsd-kind-icon" > copy< / 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 >
< 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 >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< 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 >
< / body >
< / html >
