|
1 | 1 | # Chokidar [](https://github.com/paulmillr/chokidar) [](https://github.com/paulmillr/chokidar) |
2 | 2 |
|
3 | | -> A neat wrapper around Node.js fs.watch / fs.watchFile / FSEvents. |
| 3 | +> Minimal and efficient cross-platform file watching library |
4 | 4 |
|
5 | 5 | [](https://www.npmjs.com/package/chokidar) |
6 | 6 |
|
7 | | -Version 3 is out! Check out our blog post about it: [Chokidar 3: How to save 32TB of traffic every week](https://paulmillr.com/posts/chokidar-3-save-32tb-of-traffic/) |
8 | | - |
9 | 7 | ## Why? |
10 | 8 |
|
11 | 9 | Node.js `fs.watch`: |
@@ -35,6 +33,8 @@ Initially made for **[Brunch](https://brunch.io/)** (an ultra-swift web app buil |
35 | 33 | and [many others](https://www.npmjs.com/browse/depended/chokidar). |
36 | 34 | It has proven itself in production environments. |
37 | 35 |
|
| 36 | +Version 3 is out! Check out our blog post about it: [Chokidar 3: How to save 32TB of traffic every week](https://paulmillr.com/posts/chokidar-3-save-32tb-of-traffic/) |
| 37 | + |
38 | 38 | ## How? |
39 | 39 |
|
40 | 40 | Chokidar does still rely on the Node.js core `fs` module, but when using |
@@ -74,7 +74,7 @@ chokidar.watch('.').on('all', (event, path) => { |
74 | 74 | ## API |
75 | 75 |
|
76 | 76 | ```javascript |
77 | | -// Example of a more typical implementation structure: |
| 77 | +// Example of a more typical implementation structure |
78 | 78 |
|
79 | 79 | // Initialize watcher. |
80 | 80 | const watcher = chokidar.watch('file, dir, glob, or array', { |
@@ -286,7 +286,8 @@ execute a command on each change, or get a stdio stream of change events. |
286 | 286 | ## Changelog |
287 | 287 |
|
288 | 288 | For more detailed changelog, see [`full_changelog.md`](.github/full_changelog.md). |
289 | | -- **v3.4 (Apr 26, 2020):** Support for directory-based symlinks. Macos file replacement fixes. |
| 289 | +- **v3.5 (Jan 6, 2021):** Support for ARM Macs with Apple Silicon. Fixes for deleted symlinks. |
| 290 | +- **v3.4 (Apr 26, 2020):** Support for directory-based symlinks. Fixes for macos file replacement. |
290 | 291 | - **v3.3 (Nov 2, 2019):** `FSWatcher#close()` method became async. That fixes IO race conditions related to close method. |
291 | 292 | - **v3.2 (Oct 1, 2019):** Improve Linux RAM usage by 50%. Race condition fixes. Windows glob fixes. Improve stability by using tight range of dependency versions. |
292 | 293 | - **v3.1 (Sep 16, 2019):** dotfiles are no longer filtered out by default. Use `ignored` option if needed. Improve initial Linux scan time by 50%. |
|
0 commit comments