# watchr > Better file system watching for Node.js Latest version **6.11.0** (published 2021-07-30) · MIT license · 0 weekly downloads ## Install ```sh npm install watchr pnpm add watchr yarn add watchr bun add watchr ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 6.11.0 | | Published | 2021-07-30 | | First published | 2011-11-13 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=10 | | Dependencies | 6 | | Unpacked size | 61.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 531 | | Author | 2012+ Bevry Pty Ltd | | Maintainers | balupton, bevryme | | Keywords | esnext, fs, fswatcher, node, typed, types, watch, watchfile, watching | ## Links - npm: https://www.npmjs.com/package/watchr - Repository: https://github.com/bevry/watchr - Issues: https://github.com/bevry/watchr/issues - Funding: https://bevry.me/fund - npm.io page: https://npm.io/package/watchr ## Dependencies (6) - [eachr](https://npm.io/package/eachr.md) ^4.5.0 - [safefs](https://npm.io/package/safefs.md) ^6.16.0 - [extendr](https://npm.io/package/extendr.md) ^5.19.0 - [ignorefs](https://npm.io/package/ignorefs.md) ^3.17.0 - [taskgroup](https://npm.io/package/taskgroup.md) ^7.19.0 - [scandirectory](https://npm.io/package/scandirectory.md) ^6.16.0 ## Alternatives - [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads - [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads - [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads - [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads - [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads ## Recent versions - 6.11.0 (latest) — 2021-07-30 - 6.11.0-next.1627675492.f63a0f6774cc3e38ecad32f55571e2276dd6c7cd (next) — 2021-07-30 - 6.10.0 — 2021-07-28 - 6.10.0-next.1627434539.e60bac757745cc63aba8035dd2a734d64d5bf127 — 2021-07-28 - 6.9.0-next.1603946405.da4ff1ebffde6bb548d7577d695281fcb484b0e0 — 2020-10-29 - 6.9.0 — 2020-10-29 - 6.8.0-next.1603620738.9edf3923599ef6bce567a9827b85921c52e6563d — 2020-10-25 - 6.8.0-next.1603619932.02b9cacda5958aa174f3bb19def66a5c9be135c9 — 2020-10-25 - 6.8.0-next.1603013902.f2af01f5a4e4de5a18f72a561b86f118e1d04087 — 2020-10-18 - 6.8.0-next.1602405766.5851463a473e2d42a2d10bb03befaf0f8b801c30 — 2020-10-11 - 6.8.0-next.1601204165.160d41e24ee2304fae83cf6cd7d7993a734ef050 — 2020-09-27 - 6.8.0-next.1601203390.385ffbaf495efe8f4dd34f8081331bedd1bbb452 — 2020-09-27 - 6.8.0-next.1600597837.5b0537b1d272ea82241610de02d496d2768f47ef — 2020-09-20 - 6.8.0-next.1600596318.28400e20910df4c306942773b208c41042e94fe2 — 2020-09-20 - 6.8.0-next.1599990555.8c7bb2c19bfe458eb956b02b1bc17300a046a0e8 — 2020-09-13 - … 107 more at https://npm.io/package/watchr/versions ## README

watchr

Watchr provides a normalised API the file watching APIs of different node versions, nested/recursive file and directory watching, and accurate detailed events for file/directory creations, updates, and deletions. ## Usage [Complete API Documentation.](http://master.watchr.bevry.surge.sh/docs/) There are two concepts in watchr, they are: - Watcher - this wraps the native file system watching, makes it reliable, and supports deep watching - Stalker - this wraps the watcher, such that for any given path, there can be many stalkers, but only one watcher The simplest usage is: ```javascript // Import the watching library var watchr = require('watchr') // Define our watching parameters var path = process.cwd() function listener(changeType, fullPath, currentStat, previousStat) { switch (changeType) { case 'update': console.log( 'the file', fullPath, 'was updated', currentStat, previousStat ) break case 'create': console.log('the file', fullPath, 'was created', currentStat) break case 'delete': console.log('the file', fullPath, 'was deleted', previousStat) break } } function next(err) { if (err) return console.log('watch failed on', path, 'with error', err) console.log('watch successful on', path) } // Watch the path with the change listener and completion callback var stalker = watchr.open(path, listener, next) // Close the stalker of the watcher stalker.close() ``` More advanced usage is: ```javascript // Create the stalker for the path var stalker = watchr.create(path) // Listen to the events for the stalker/watcher stalker.on('change', listener) stalker.on('log', console.log) stalker.once('close', function (reason) { console.log('closed', path, 'because', reason) stalker.removeAllListeners() // as it is closed, no need for our change or log listeners any more }) // Set the default configuration for the stalker/watcher stalker.setConfig({ stat: null, interval: 5007, persistent: true, catchupDelay: 2000, preferredMethods: ['watch', 'watchFile'], followLinks: true, ignorePaths: false, ignoreHiddenFiles: false, ignoreCommonPatterns: true, ignoreCustomPatterns: null, }) // Start watching stalker.watch(next) // Stop watching stalker.close() ```

Install

npm

Install: npm install --save watchr
Import: import * as pkg from ('watchr')
Require: const pkg = require('watchr')

Editions

This package is published with the following editions:

watchr aliases watchr/source/index.js
watchr/source/index.js is ESNext source code for Node.js 10 || 12 || 14 || 16 with Require for modules

TypeScript

This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth compiler option to `5` or thereabouts. You can accomlish this via your `tsconfig.json` file like so: ``` json { "compilerOptions": { "maxNodeModuleJsDepth": 5 } } ```