@ms-cloudpack/file-watcher

An abstraction on the file watching capabilities used in Cloudpack.

Example usage

1. Create a watcher:

const watcher = createWatcher();

2. Subscribe to a particular package path using watch. (Returns an unwatch function.)

const unwatch = watcher.watch({ path: 'path/to/package' }, () => console.log(`package changed`));

3. To dispose, call the returned unwatch, or call watcher.unwatchAll to unsubscribe from all watchers.

// Dispose an individual watcher.
await unwatch();

// Dispose all watchers.
await watcher.unwatchAll();

watcher.watch options

Name	Type	Description
path	string	The absolute base path to be watched.
watchedPaths	string[]	Relative paths from the base path to watch. Defaults to package.json and src/ folder.