Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext
common/plugin-api-rpc
FileSystemMain
Interface FileSystemMain
interface
FileSystemMain
{
$copy
(
resource
:
UriComponents
,
target
:
UriComponents
,
opts
:
FileOverwriteOptions
,
)
:
Promise
<
void
>
;
$delete
(
resource
:
UriComponents
,
opts
:
FileDeleteOptions
)
:
Promise
<
void
>
;
$mkdir
(
resource
:
UriComponents
)
:
Promise
<
void
>
;
$onFileSystemChange
(
handle
:
number
,
resource
:
IFileChangeDto
[]
)
:
void
;
$readdir
(
resource
:
UriComponents
)
:
Promise
<
[
string
,
FileType
]
[]
>
;
$readFile
(
resource
:
UriComponents
)
:
Promise
<
BinaryBuffer
>
;
$registerFileSystemProvider
(
handle
:
number
,
scheme
:
string
,
capabilities
:
FileSystemProviderCapabilities
,
readonlyMessage
?:
MarkdownString
,
)
:
void
;
$rename
(
resource
:
UriComponents
,
target
:
UriComponents
,
opts
:
FileOverwriteOptions
,
)
:
Promise
<
void
>
;
$stat
(
uri
:
UriComponents
)
:
Promise
<
Stat
>
;
$unregisterProvider
(
handle
:
number
)
:
void
;
$writeFile
(
resource
:
UriComponents
,
content
:
BinaryBuffer
)
:
Promise
<
void
>
;
}
Implemented by
FileSystemMainImpl
Index
Methods
$copy
$delete
$mkdir
$on
File
System
Change
$readdir
$read
File
$register
File
System
Provider
$rename
$stat
$unregister
Provider
$write
File
Methods
$copy
$copy
(
resource
:
UriComponents
,
target
:
UriComponents
,
opts
:
FileOverwriteOptions
,
)
:
Promise
<
void
>
Parameters
resource
:
UriComponents
target
:
UriComponents
opts
:
FileOverwriteOptions
Returns
Promise
<
void
>
$delete
$delete
(
resource
:
UriComponents
,
opts
:
FileDeleteOptions
)
:
Promise
<
void
>
Parameters
resource
:
UriComponents
opts
:
FileDeleteOptions
Returns
Promise
<
void
>
$mkdir
$mkdir
(
resource
:
UriComponents
)
:
Promise
<
void
>
Parameters
resource
:
UriComponents
Returns
Promise
<
void
>
$on
File
System
Change
$onFileSystemChange
(
handle
:
number
,
resource
:
IFileChangeDto
[]
)
:
void
Parameters
handle
:
number
resource
:
IFileChangeDto
[]
Returns
void
$readdir
$readdir
(
resource
:
UriComponents
)
:
Promise
<
[
string
,
FileType
]
[]
>
Parameters
resource
:
UriComponents
Returns
Promise
<
[
string
,
FileType
]
[]
>
$read
File
$readFile
(
resource
:
UriComponents
)
:
Promise
<
BinaryBuffer
>
Parameters
resource
:
UriComponents
Returns
Promise
<
BinaryBuffer
>
$register
File
System
Provider
$registerFileSystemProvider
(
handle
:
number
,
scheme
:
string
,
capabilities
:
FileSystemProviderCapabilities
,
readonlyMessage
?:
MarkdownString
,
)
:
void
Parameters
handle
:
number
scheme
:
string
capabilities
:
FileSystemProviderCapabilities
Optional
readonlyMessage
:
MarkdownString
Returns
void
$rename
$rename
(
resource
:
UriComponents
,
target
:
UriComponents
,
opts
:
FileOverwriteOptions
,
)
:
Promise
<
void
>
Parameters
resource
:
UriComponents
target
:
UriComponents
opts
:
FileOverwriteOptions
Returns
Promise
<
void
>
$stat
$stat
(
uri
:
UriComponents
)
:
Promise
<
Stat
>
Parameters
uri
:
UriComponents
Returns
Promise
<
Stat
>
$unregister
Provider
$unregisterProvider
(
handle
:
number
)
:
void
Parameters
handle
:
number
Returns
void
$write
File
$writeFile
(
resource
:
UriComponents
,
content
:
BinaryBuffer
)
:
Promise
<
void
>
Parameters
resource
:
UriComponents
content
:
BinaryBuffer
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
$copy
$delete
$mkdir
$on
File
System
Change
$readdir
$read
File
$register
File
System
Provider
$rename
$stat
$unregister
Provider
$write
File
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...