Class FileSystemWatcher

A file system watcher notifies about changes to files and folders on disk.

To get an instance of a FileSystemWatcher use createFileSystemWatcher.

Implements

FileSystemWatcher

Index

Constructors

Accessors

ignoreChangeEvents ignoreCreateEvents ignoreDeleteEvents onDidChange onDidCreate onDidDelete

Methods

Constructors

constructor

new FileSystemWatcher(
    dispatcher: Event<FileSystemEvents>,
    globPattern: string | IRelativePattern,
    ignoreCreateEvents?: boolean,
    ignoreChangeEvents?: boolean,
    ignoreDeleteEvents?: boolean,
    excludes?: string[],
): FileSystemWatcher
Parameters
- dispatcher: Event<FileSystemEvents>
- globPattern: string | IRelativePattern
- OptionalignoreCreateEvents: boolean
- OptionalignoreChangeEvents: boolean
- OptionalignoreDeleteEvents: boolean
- Optionalexcludes: string[]
Returns FileSystemWatcher
- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:71

Accessors

ignoreChangeEvents

get ignoreChangeEvents(): boolean
true if this file system watcher has been created such that it ignores change file system events.

Returns boolean
Implementation of FileSystemWatcher.ignoreChangeEvents
- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:63

ignoreCreateEvents

get ignoreCreateEvents(): boolean
true if this file system watcher has been created such that it ignores creation file system events.

Returns boolean
Implementation of FileSystemWatcher.ignoreCreateEvents
- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:59

ignoreDeleteEvents

get ignoreDeleteEvents(): boolean
true if this file system watcher has been created such that it ignores delete file system events.

Returns boolean
Implementation of FileSystemWatcher.ignoreDeleteEvents
- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:67

onDidChange

get onDidChange(): Event<Uri>
An event which fires on file/folder change.

Returns Event<Uri>
Implementation of FileSystemWatcher.onDidChange
- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:126

onDidCreate

get onDidCreate(): Event<Uri>
An event which fires on file/folder creation.

Returns Event<Uri>
Implementation of FileSystemWatcher.onDidCreate
- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:122

onDidDelete

get onDidDelete(): Event<Uri>
An event which fires on file/folder deletion.

Returns Event<Uri>
Implementation of FileSystemWatcher.onDidDelete
- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:130

Methods

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of FileSystemWatcher.dispose
- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:118