Class NsfwFileSystemWatcherService

Hierarchy

NsfwFileSystemWatcherService

Implements

FileSystemWatcherService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NsfwFileSystemWatcherService(options?: Partial<NsfwFileSystemWatcherServerOptions>): NsfwFileSystemWatcherService

- Defined in packages/filesystem/src/node/nsfw-watcher/nsfw-filesystem-service.ts:396
Parameters
- Optional options: Partial<NsfwFileSystemWatcherServerOptions>
Returns NsfwFileSystemWatcherService

Properties

Protected client

client: undefined | FileSystemWatcherServiceClient

Protected Readonly maybeClient

maybeClient: FileSystemWatcherServiceClient = ...

this.client is undefined until someone sets it.

Protected Readonly options

options: NsfwFileSystemWatcherServerOptions

Protected Readonly watcherHandles

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

Protected watcherId

watcherId: number = 0

Protected Readonly watchers

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

Methods

Protected createWatcher

createWatcher(clientId: number, fsPath: string, options: WatchOptions): NsfwWatcher

- Defined in packages/filesystem/src/node/nsfw-watcher/nsfw-filesystem-service.ts:433
Parameters
- clientId: number
- fsPath: string
- options: WatchOptions
Returns NsfwWatcher

Protected debug

debug(message: string, ...params: any[]): void

- Defined in packages/filesystem/src/node/nsfw-watcher/nsfw-filesystem-service.ts:472
Parameters
- message: string
- Rest ...params: any[]
Returns void

dispose

dispose(): void

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

Protected getWatcherKey

getWatcherKey(uri: string, options: WatchOptions): string

- Defined in packages/filesystem/src/node/nsfw-watcher/nsfw-filesystem-service.ts:454
Given some URI and some WatchOptions, generate a unique key.

Parameters
- uri: string
- options: WatchOptions
Returns string

Protected resolveWatchOptions

resolveWatchOptions(options?: WatchOptions): WatchOptions

- Defined in packages/filesystem/src/node/nsfw-watcher/nsfw-filesystem-service.ts:464
Return fully qualified options.

Parameters
- Optional options: WatchOptions
Returns WatchOptions

setClient

setClient(client: undefined | FileSystemWatcherServiceClient): void

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

unwatchFileChanges

unwatchFileChanges(watcherId: number): Promise<void>

Implementation of FileSystemWatcherService.unwatchFileChanges
- Defined in packages/filesystem/src/node/nsfw-watcher/nsfw-filesystem-service.ts:441
Parameters
- watcherId: number
Returns Promise<void>

watchFileChanges

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

Implementation of FileSystemWatcherService.watchFileChanges
- Defined in packages/filesystem/src/node/nsfw-watcher/nsfw-filesystem-service.ts:415
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>