VS Code API
    Preparing search index...

    Interface 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 workspace.fs.

    interface FileSystem {
        copy(
            source: Uri,
            target: Uri,
            options?: { overwrite?: boolean },
        ): Thenable<void>;
        createDirectory(uri: Uri): Thenable<void>;
        delete(
            uri: Uri,
            options?: { recursive?: boolean; useTrash?: boolean },
        ): Thenable<void>;
        isWritableFileSystem(scheme: string): boolean | undefined;
        readDirectory(uri: Uri): Thenable<[string, FileType][]>;
        readFile(uri: Uri): Thenable<Uint8Array<ArrayBufferLike>>;
        rename(
            source: Uri,
            target: Uri,
            options?: { overwrite?: boolean },
        ): Thenable<void>;
        stat(uri: Uri): Thenable<FileStat>;
        writeFile(uri: Uri, content: Uint8Array): Thenable<void>;
    }
    Index

    Methods

    copy createDirectory delete isWritableFileSystem readDirectory readFile rename stat writeFile

    Methods

    • Copy files or folders.

      Parameters

      • source: Uri

        The existing file.

      • target: Uri

        The destination location.

      • Optionaloptions: { overwrite?: boolean }

        Defines if existing files should be overwritten.

        • Optionaloverwrite?: boolean

          Overwrite the file if it does exist.

      Returns Thenable<void>

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

      Note that missing directories are created automatically, e.g this call has mkdirp semantics.

      Parameters

      • uri: Uri

        The uri of the new folder.

      Returns Thenable<void>

    • Delete a file.

      Parameters

      • uri: Uri

        The resource that is to be deleted.

      • Optionaloptions: { recursive?: boolean; useTrash?: boolean }

        Defines if trash can should be used and if deletion of folders is recursive

        • Optionalrecursive?: boolean

          Delete the content recursively if a folder is denoted.

        • OptionaluseTrash?: boolean

          Use the os's trashcan instead of permanently deleting files whenever possible.

      Returns Thenable<void>

    • Check if a given file system supports writing files.

      Keep in mind that just because a file system supports writing, that does not mean that writes will always succeed. There may be permissions issues or other errors that prevent writing a file.

      Parameters

      • scheme: string

        The scheme of the filesystem, for example file or git.

      Returns boolean | undefined

      true if the file system supports writing, false if it does not support writing (i.e. it is readonly), and undefined if the editor does not know about the filesystem.

    • Rename a file or folder.

      Parameters

      • source: Uri

        The existing file.

      • target: Uri

        The new location.

      • Optionaloptions: { overwrite?: boolean }

        Defines if existing files should be overwritten.

        • Optionaloverwrite?: boolean

          Overwrite the file if it does exist.

      Returns Thenable<void>

    Settings

    Member Visibility

    On This Page

    Methods