![\"Status](\"https://github.com/bevry/watchr/workflows/bevry/badge.svg\"){kind=icon}
\n![\"NPM](\"https://img.shields.io/npm/v/watchr.svg\")
\n![\"NPM](\"https://img.shields.io/npm/dm/watchr.svg\")
\n![\"Dependency](\"https://img.shields.io/david/bevry/watchr.svg\")
\n![\"Dev](\"https://img.shields.io/david/dev/bevry/watchr.svg\")
\n![\"GitHub](\"https://img.shields.io/badge/github-donate-yellow.svg\"){kind=icon}
\n![\"Patreon](\"https://img.shields.io/badge/patreon-donate-yellow.svg\"){kind=icon}
\n![\"Flattr](\"https://img.shields.io/badge/flattr-donate-yellow.svg\"){kind=icon}
\n![\"Liberapay](\"https://img.shields.io/badge/liberapay-donate-yellow.svg\"){kind=icon}
\n![\"Buy](\"https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg\"){kind=icon}
\n![\"Open](\"https://img.shields.io/badge/open%20collective-donate-yellow.svg\"){kind=icon}
\n![\"crypto](\"https://img.shields.io/badge/crypto-donate-yellow.svg\"){kind=icon}
\n![\"PayPal](\"https://img.shields.io/badge/paypal-donate-yellow.svg\"){kind=icon}
\n![\"Wishlist](\"https://img.shields.io/badge/wishlist-donate-yellow.svg\"){kind=icon}
\n\n\n\n\nWatchr 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.\n\n## Usage\n\n[Complete API Documentation.](http://master.watchr.bevry.surge.sh/docs/)\n\nThere are two concepts in watchr, they are:\n\n- Watcher - this wraps the native file system watching, makes it reliable, and supports deep watching\n- Stalker - this wraps the watcher, such that for any given path, there can be many stalkers, but only one watcher\n\nThe simplest usage is:\n\n```javascript\n// Import the watching library\nvar watchr = require('watchr')\n\n// Define our watching parameters\nvar path = process.cwd()\nfunction listener(changeType, fullPath, currentStat, previousStat) {\n switch (changeType) {\n case 'update':\n console.log(\n 'the file',\n fullPath,\n 'was updated',\n currentStat,\n previousStat\n )\n break\n case 'create':\n console.log('the file', fullPath, 'was created', currentStat)\n break\n case 'delete':\n console.log('the file', fullPath, 'was deleted', previousStat)\n break\n }\n}\nfunction next(err) {\n if (err) return console.log('watch failed on', path, 'with error', err)\n console.log('watch successful on', path)\n}\n\n// Watch the path with the change listener and completion callback\nvar stalker = watchr.open(path, listener, next)\n\n// Close the stalker of the watcher\nstalker.close()\n```\n\nMore advanced usage is:\n\n```javascript\n// Create the stalker for the path\nvar stalker = watchr.create(path)\n\n// Listen to the events for the stalker/watcher\nstalker.on('change', listener)\nstalker.on('log', console.log)\nstalker.once('close', function (reason) {\n console.log('closed', path, 'because', reason)\n stalker.removeAllListeners() // as it is closed, no need for our change or log listeners any more\n})\n\n// Set the default configuration for the stalker/watcher\nstalker.setConfig({\n stat: null,\n interval: 5007,\n persistent: true,\n catchupDelay: 2000,\n preferredMethods: ['watch', 'watchFile'],\n followLinks: true,\n ignorePaths: false,\n ignoreHiddenFiles: false,\n ignoreCommonPatterns: true,\n ignoreCustomPatterns: null,\n})\n\n// Start watching\nstalker.watch(next)\n\n// Stop watching\nstalker.close()\n```\n\n\n\nnpm install --save watchrimport * as pkg from ('watchr')const pkg = require('watchr')This package is published with the following editions:
\n\nwatchr aliases watchr/source/index.jswatchr/source/index.js is ESNext source code for Node.js 10 || 12 || 14 || 16 with Require for modulesmaxNodeModuleJsDepth compiler option to `5` or thereabouts. You can accomlish this via your `tsconfig.json` file like so:\n\n``` json\n{\n \"compilerOptions\": {\n \"maxNodeModuleJsDepth\": 5\n }\n}\n```\n\n\n\n\n\n\nHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n