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

constructor

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

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: number,
    fsPath: string,
    options: WatchOptions,
): ParcelWatcher
Parameters
- clientId: number
- fsPath: string
- options: WatchOptions
Returns ParcelWatcher
- Defined in packages/filesystem/src/node/parcel-watcher/parcel-filesystem-service.ts:434

`Protected`debug

debug(message: string, ...params: any[]): void
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- message: string
- ...params: any[]
Returns void
- Defined in packages/filesystem/src/node/parcel-watcher/parcel-filesystem-service.ts:473

dispose

dispose(): void
Dispose this object.

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

`Protected`getWatcherKey

getWatcherKey(uri: string, options: WatchOptions): 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:455

`Protected`resolveWatchOptions

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

setClient

setClient(client: undefined | FileSystemWatcherServiceClient): 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
- client: undefined | FileSystemWatcherServiceClient
Returns void
Implementation of FileSystemWatcherService.setClient
- Defined in packages/filesystem/src/node/parcel-watcher/parcel-filesystem-service.ts:407

unwatchFileChanges

unwatchFileChanges(watcherId: number): 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:442

watchFileChanges

watchFileChanges(
    clientId: number,
    uri: string,
    options?: WatchOptions,
): 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
- Optionaloptions: WatchOptions
Returns Promise<number>
Implementation of FileSystemWatcherService.watchFileChanges
- Defined in packages/filesystem/src/node/parcel-watcher/parcel-filesystem-service.ts:416

Class ParcelFileSystemWatcherService

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ParcelFileSystemWatcherService

Properties

Protectedclient

Protected ReadonlymaybeClient

Protected Readonlyoptions

Protected ReadonlywatcherHandles

ProtectedwatcherId

Protected Readonlywatchers

Methods

ProtectedcreateWatcher

Parameters

Returns ParcelWatcher

Protecteddebug

Parameters

Returns void

dispose

Returns void

ProtectedgetWatcherKey

Parameters

Returns string

ProtectedresolveWatchOptions

Parameters

Returns WatchOptions

setClient

Parameters

Returns void

unwatchFileChanges

Parameters

Returns Promise<void>

watchFileChanges

Parameters

Returns Promise<number>

Settings

On This Page

`Protected`client

`Protected` `Readonly`maybeClient

`Protected` `Readonly`options

`Protected` `Readonly`watcherHandles

`Protected`watcherId

`Protected` `Readonly`watchers

`Protected`createWatcher

`Protected`debug

`Protected`getWatcherKey

`Protected`resolveWatchOptions