Manage a subscription to filesystem events that occur beneath a root directory. Construct these by
watchPath. To watch for events within active project directories, use Project::onDidChangeFiles
Multiple PathWatchers may be backed by a single native watcher to conserve operation system resources.
Call ::dispose to stop receiving events and, if possible, release underlying resources. A PathWatcher may be added to a CompositeDisposable to manage its lifetime along with other Disposable resources like event subscriptions.
watchPath accepts the following arguments:
rootPath String specifies the absolute path to the root of the filesystem content to watch.
options Control the watcher’s behavior. Currently a placeholder.
eventCallback Function to be called each time a batch of filesystem events is observed. Each event object has
action, a String describing the filesystem action that occurred, one of
path, a String containing the absolute path to the filesystem entry that was acted
upon; for rename events only,
oldPath, a String containing the filesystem entry’s former absolute path.
Return a Promise that will resolve when the underlying native watcher is ready to begin sending events. When testing filesystem watchers, it’s important to await this promise before making filesystem changes that you intend to assert about because there will be a delay between the instantiation of the watcher and the activation of the underlying OS resources that feed it events.
PathWatchers acquired through
watchPath are already started.
Unsubscribe all subscribers from filesystem events. Native resources will be release asynchronously, but this watcher will stop broadcasting events immediately.