FileSystem

The file system interface exposes the editor's built-in and contributed file system providers. It allows extensions to work with files from the local disk as well as files from remote places, like the remote extension host or ftp-servers.

Note that an instance of this interface is available as {@linkcode workspace.fs}.

Online Documentation

Types

CopyOptions

interface CopyOptions

DeleteOptions

interface DeleteOptions

RenameOptions

interface RenameOptions

Functions

copy

abstract fun copy(source: Uri, target: Uri, options: FileSystem.CopyOptions = definedExternally): PromiseLike<Void?>

Copy files or folders.

createDirectory

abstract fun createDirectory(uri: Uri): PromiseLike<Void?>

Create a new directory (Note, that new files are created via write-calls).

delete

abstract fun delete(uri: Uri, options: FileSystem.DeleteOptions = definedExternally): PromiseLike<Void?>

Delete a file.

isWritableFileSystem

abstract fun isWritableFileSystem(scheme: String): Boolean?

Check if a given file system supports writing files.

readDirectory

abstract fun readDirectory(uri: Uri): PromiseLike<ReadonlyArray<Tuple2<JsString, FileType>>>

Retrieve all entries of a directory.

readFile

abstract fun readFile(uri: Uri): PromiseLike<Uint8Array<*>>

Read the entire contents of a file.

rename

abstract fun rename(source: Uri, target: Uri, options: FileSystem.RenameOptions = definedExternally): PromiseLike<Void?>

Rename a file or folder.

stat

abstract fun stat(uri: Uri): PromiseLike<FileStat>

Retrieve metadata about a file.

writeFile

abstract fun writeFile(uri: Uri, content: Uint8Array<*>): PromiseLike<Void?>

Write data to a file, replacing its entire contents.