metarhia / metawatch

Nested directories watch for node.js 🕵️

Deep nested directories watch for node.js

• Watch directories recursive
• Rebuild recursive when new directories found or old directories remove
• Deduplicate events with debounce

Usage

const metawatch = require('metawatch');

const watcher = new metawatch.DirectoryWatcher({ timeout: 200 });
watcher.watch('/home/marcus/Downloads');
watcher.watch('/home/marcus/Documents');

watcher.on('change', (fileName) => {
  console.log({ changed: fileName });
});

watcher.on('delete', (fileName) => {
  console.log({ deleted: fileName });
});

watcher.on('before', (changes) => {
  console.log({ changes });
});

watcher.on('after', (changes) => {
  console.log({ changes });
});

Contributors

• Timur Shemsedinov [email protected]
• See github for full contributors list

License & Contributors

Copyright (c) 2020-2023 Metarhia contributors. Metawatch is MIT licensed. Metawatch is a part of Metarhia technology stack.

metawatch's Issues

Remove listener

Implement removeWatch or something like FSWatcher.close();

Rebuild recursive

If we create or delete directory inside watched directory, watch should be added or removed respectively.

• linux
• macos
• windows

Deduplicate events

Sometimes fs.watch sends duplicate events or other processes can generate directory/file events in sequence so we need to add timeout for events deduplication and fire events just once per timeout (like debounce or throttle do).

Recursive watch

• linux
• macos
• windows