| Interface | Description |
|---|---|
| ProjectWatch | |
| Transport |
An abstraction for IPC via messages.
|
| WatchmanClient |
Testable interface for a Watchman client.
|
| WatchmanDiagnostic | |
| WatchmanEvent |
Interface for all Watchman events, requires them to have a base path
|
| Class | Description |
|---|---|
| Watchman |
Contains the configuration for a Watchman client as well as the ability to create a client.
|
| WatchmanCursor | |
| WatchmanDiagnosticEvent | |
| WatchmanDiagnosticEventListener |
Deduplicating event bus listener that outputs deduplicated messages over the given event bus.
|
| WatchmanFactory |
Factory that is responsible for creating instances of
Watchman. |
| WatchmanMultiplePathEvent |
Buck sends this event for all files, directories and symlinks that were changed since last
invalidation
|
| WatchmanMultiplePathEvent.Change |
Contains path and type of file system change
|
| WatchmanOverflowEvent |
Buck sends this event when Watchman is unable to correctly determine the whole set of changes in
the filesystem, or if too many files have changed
|
| WatchmanPathEvent |
Buck sends this event for every file that was added, modified or deleted
|
| WatchmanWatcher |
Queries Watchman for changes to a path.
|
| Enum | Description |
|---|---|
| Capability |
Various capabilities
supported by different versions of Watchman.
|
| WatchmanDiagnostic.Level | |
| WatchmanEvent.Kind |
The kind of event that occurred in watched file system, like creation of a new file
|
| WatchmanEvent.Type |
Type of the file that was changed, like a regular file or a directory
|
| WatchmanWatcher.CursorType | |
| WatchmanWatcher.FreshInstanceAction |
| Exception | Description |
|---|---|
| FileSystemNotWatchedException |
A
Watchman object does not have a necessary ProjectWatch. |
| WatchmanQueryFailedException |
Watchman returned an error response.
|
| WatchmanQueryTimedOutException |
Watchman took too long to respond to a query.
|
| WatchmanWatcherException |