Interface FileSystemWatcherServer

Hierarchy

JsonRpcServer<FileSystemWatcherClient>
- FileSystemWatcherServer

Index

Methods

Methods

dispose

dispose(): void

Inherited from JsonRpcServer.dispose
- Defined in packages/core/lib/common/disposable.d.ts:21
Dispose this object.

Returns void

Optional getClient

getClient(): undefined | FileSystemWatcherClient

Inherited from JsonRpcServer.getClient
- Defined in packages/core/lib/common/messaging/proxy-factory.d.ts:27
Returns undefined | FileSystemWatcherClient

setClient

setClient(client: undefined | FileSystemWatcherClient): void

Inherited from JsonRpcServer.setClient
- Defined in packages/core/lib/common/messaging/proxy-factory.d.ts:26
If this server is a proxy to a remote server then a client is used as a local object to handle JSON-RPC messages from the remote server.

Parameters
- client: undefined | FileSystemWatcherClient
Returns void

unwatchFileChanges

unwatchFileChanges(watcherId: number): Promise<void>

- Defined in packages/filesystem/src/common/filesystem-watcher-protocol.ts:76
Stop file watching for the given id. Resolve when watching is stopped.

Parameters
- watcherId: number
Returns Promise<void>

watchFileChanges

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

- Defined in packages/filesystem/src/common/filesystem-watcher-protocol.ts:70
Start file watching for the given param. Resolve when watching is started. Return a watcher id.

Parameters
- uri: string
- Optional options: WatchOptions
Returns Promise<number>