chokidar-debounced

Summary

This package provides debounce behavior to chokidar, similar to how nodemon's delay property works.

chokidar lacks debounce functionality. This means that when bulk file changes occur, chokidar will call the provided callback function multiple times almost-simultaneously. This is, in most cases, undesirable.

Bulk file changes can occur when one:

• Bulk-saves multiple files (e.g. Ctrl+K, Ctrl+S in vscode)
• Copying a directory
• Deleting multiple files
• Etc.

Usage

npm install chokidar-debounced

Default chokidar options (good for most situations):

1import { watch } from 'chokidar-debounced'
2
3watch(() => console.log('Something changed!'), ['./'])

Providing own watcher:

1import chokidar from 'chokidar'
2import { watch } from 'chokidar-debounced'
3
4const watcher = chokidar.watch(['./'], { /* chokidar options */ })
5
6watch(() => console.log('Something changed!'), watcher)

Providing a function to call when the watcher has completed initializing (chokidar's ready event):

1import { watch } from 'chokidar-debounced'
2
3watch(() => console.log('Something changed!'), ['./'], 500, () => console.log('Watching for changes...'))