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.

Hierarchy

JsonRpcServer<FileSystemWatcherServiceClient>
- FileSystemWatcherService

Index

Methods

Methods

unwatchFileChanges

unwatchFileChanges(watcherId: number): Promise<void>

- Defined in packages/filesystem/src/common/filesystem-watcher-protocol.ts:38
Parameters
- watcherId: number
  
  handle mapping to a previous watchFileChanges request.
Returns Promise<void>

watchFileChanges

watchFileChanges(clientId: number, uri: string, options?: WatchOptions): Promise<number>

- Defined in packages/filesystem/src/common/filesystem-watcher-protocol.ts:34
Parameters
- clientId: number
  
  arbitrary id used to identify a client.
- uri: string
  
  the path to watch.
- Optional options: WatchOptions
  
  optional parameters.
Returns Promise<number>
promise to a unique number handle for this request.