@ms-cloudpack/file-watcher

@ms-cloudpack/file-watcher

An abstraction on the file watching capabilities used in Cloudpack.

Example usage

• Create a watcher:

const watcher = createWatcher();

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

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

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

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

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

createWatcher options

• type ('default' | 'fork', optional): By default, this will create a watcher in the same thread. Use type: 'fork' to create the watcher in a forked process.

watcher.watch options

• path (string): The absolute root path to be watched.
• id (string, optional): ID for the watch job (defaults to path). If you call watch twice using the same id, subsequent calls will be ignored.
• watchPaths (string[], optional): Relative paths/globs from the root path. Currently, only negative globs (starting with !) are supported and will be used to ignore files. Positive globs are ignored - the watcher will watch all files in the root path by default. Defaults are under "@ms-cloudpack/path-utilities" in sourceFilesGlobs.