Class ParcelFileSystemWatcherService

Singleton implementation of the watch server.

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

Implements

FileSystemWatcherService

Index

Constructors

Properties

client maybeClient options watcherHandles watcherId watchers

Methods

createWatcher debug dispose getWatcherKey resolveWatchOptions setClient unwatchFileChanges watchFileChanges

Constructors

constructor

new ParcelFileSystemWatcherService(options?): ParcelFileSystemWatcherService
Parameters
- Optional options: Partial<ParcelFileSystemWatcherServerOptions>
Returns ParcelFileSystemWatcherService
- Defined in packages/filesystem/src/node/parcel-watcher/parcel-filesystem-service.ts:386

Properties

`Protected` client

client: undefined | FileSystemWatcherServiceClient

`Protected` `Readonly` maybeClient

maybeClient: FileSystemWatcherServiceClient = ...

this.client is undefined until someone sets it.

`Protected` `Readonly` options

options: ParcelFileSystemWatcherServerOptions

`Protected` `Readonly` watcherHandles

watcherHandles: Map<number, PacelWatcherHandle> = ...

`Protected` watcherId

watcherId: number = 0

`Protected` `Readonly` watchers

watchers: Map<string, ParcelWatcher> = ...

Methods

`Protected` createWatcher

createWatcher(clientId, fsPath, options): ParcelWatcher
Parameters
- clientId: number
- fsPath: string
- options: WatchOptions
Returns ParcelWatcher
- Defined in packages/filesystem/src/node/parcel-watcher/parcel-filesystem-service.ts:423

`Protected` debug

debug(message, ...params): void
Parameters
- message: string
- Rest ...params: any[]
Returns void
- Defined in packages/filesystem/src/node/parcel-watcher/parcel-filesystem-service.ts:462

dispose

dispose(): void
Returns void
Implementation of FileSystemWatcherService.dispose
- Defined in packages/filesystem/src/node/parcel-watcher/parcel-filesystem-service.ts:468

`Protected` getWatcherKey

getWatcherKey(uri, options): string
Given some URI and some WatchOptions, generate a unique key.
Parameters
- uri: string
- options: WatchOptions
Returns string
- Defined in packages/filesystem/src/node/parcel-watcher/parcel-filesystem-service.ts:444

`Protected` resolveWatchOptions

resolveWatchOptions(options?): WatchOptions
Return fully qualified options.
Parameters
- Optional options: WatchOptions
Returns WatchOptions
- Defined in packages/filesystem/src/node/parcel-watcher/parcel-filesystem-service.ts:454

setClient

setClient(client): void
Parameters
- client: undefined | FileSystemWatcherServiceClient
Returns void
Implementation of FileSystemWatcherService.setClient
- Defined in packages/filesystem/src/node/parcel-watcher/parcel-filesystem-service.ts:396

unwatchFileChanges

unwatchFileChanges(watcherId): Promise<void>
Parameters
- watcherId: number
  handle mapping to a previous watchFileChanges request.
Returns Promise<void>
Implementation of FileSystemWatcherService.unwatchFileChanges
- Defined in packages/filesystem/src/node/parcel-watcher/parcel-filesystem-service.ts:431

watchFileChanges

watchFileChanges(clientId, uri, options?): Promise<number>
A specific client requests us to watch a given uri according to some options.

We internally re-use all the same (uri, options) pairs.
Parameters
- clientId: number
- uri: string
- Optional options: WatchOptions
Returns Promise<number>
Implementation of FileSystemWatcherService.watchFileChanges
- Defined in packages/filesystem/src/node/parcel-watcher/parcel-filesystem-service.ts:405