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

    Interface FileSystemWatcherService

    Singleton implementation of the watch server.

    Since multiple clients all make requests to this service, we need to track those individually via a clientId.

    interface FileSystemWatcherService {
        dispose(): void;
        getClient?(): undefined | FileSystemWatcherServiceClient;
        setClient(client: undefined | FileSystemWatcherServiceClient): void;
        unwatchFileChanges(watcherId: number): Promise<void>;
        watchFileChanges(
            clientId: number,
            uri: string,
            options?: WatchOptions,
        ): Promise<number>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    dispose getClient? setClient unwatchFileChanges watchFileChanges

    Methods

    • Dispose this object.

      Returns void

    • If this server is a proxy to a remote server then a client is used as a local object to handle RPC messages from the remote server.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods