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 {
unwatchFileChanges(watcherId): Promise<void>;
watchFileChanges(clientId, uri, options?): Promise<number>;
}

Hierarchy

RpcServer<FileSystemWatcherServiceClient>
- FileSystemWatcherService

Implemented by

ParcelFileSystemWatcherService

Index

Methods

unwatchFileChanges watchFileChanges

Methods

unwatchFileChanges

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

watchFileChanges

watchFileChanges(clientId, uri, options?): Promise<number>
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.
- Defined in packages/filesystem/src/common/filesystem-watcher-protocol.ts:34