Theia API Documentation v1.66.0
    Preparing search index...

    Interface FileSystemProviderWithFileReadStreamCapability

    Subtype of FileSystemProvider that ensures that the optional functions, needed for providers that should be able to read files as streams, are implemented.

    interface FileSystemProviderWithFileReadStreamCapability {
        capabilities: FileSystemProviderCapabilities;
        onDidChangeCapabilities: Event<void>;
        onDidChangeFile: Event<readonly FileChange[]>;
        onFileWatchError: Event<void>;
        access?(resource: URI, mode?: number): Promise<void>;
        close?(fd: number): Promise<void>;
        copy?(from: URI, to: URI, opts: FileOverwriteOptions): Promise<void>;
        delete(resource: URI, opts: FileDeleteOptions): Promise<void>;
        fsPath?(resource: URI): Promise<string>;
        mkdir(resource: URI): Promise<void>;
        open?(resource: URI, opts: FileOpenOptions): Promise<number>;
        read?(
            fd: number,
            pos: number,
            data: Uint8Array,
            offset: number,
            length: number,
        ): Promise<number>;
        readdir(resource: URI): Promise<[string, FileType][]>;
        readFile?(resource: URI): Promise<Uint8Array>;
        readFileStream(
            resource: URI,
            opts: FileReadStreamOptions,
            token: CancellationToken,
        ): ReadableStreamEvents<Uint8Array>;
        rename(from: URI, to: URI, opts: FileOverwriteOptions): Promise<void>;
        stat(resource: URI): Promise<Stat>;
        updateFile?(
            resource: URI,
            changes: TextDocumentContentChangeEvent[],
            opts: FileUpdateOptions,
        ): Promise<FileUpdateResult>;
        watch(resource: URI, opts: WatchOptions): Disposable;
        write?(
            fd: number,
            pos: number,
            data: Uint8Array,
            offset: number,
            length: number,
        ): Promise<number>;
        writeFile?(
            resource: URI,
            content: Uint8Array,
            opts: FileWriteOptions,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities onDidChangeCapabilities onDidChangeFile onFileWatchError

    Methods

    access? close? copy? delete fsPath? mkdir open? read? readdir readFile? readFileStream rename stat updateFile? watch write? writeFile?

    Properties

    capabilities: FileSystemProviderCapabilities

    The FileSystemProviderCapabilities for this provider.

    onDidChangeCapabilities: Event<void>
    • Event that is fired if the capabilities of this provider have changed.
    onDidChangeFile: Event<readonly FileChange[]>

    Event that is fired if a (watched) file in the filesystem of this provider has changed.

    onFileWatchError: Event<void>

    Event that is fired if an error occurred when watching files in the filesystem of this provider.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods