https://github.com/bevry/watchr

Better file system watching for Node.js. 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 changes, deletions and creations.
https://github.com/bevry/watchr

executable file-watchers javascript nodejs

Last synced: about 2 months ago
JSON representation

Better file system watching for Node.js. 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 changes, deletions and creations.

• Host: GitHub
• URL: https://github.com/bevry/watchr
• Owner: bevry
• License: other
• Created: 2011-11-13T11:05:55.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2024-01-07T18:06:51.000Z (9 months ago)
• Last Synced: 2024-03-22T14:18:29.363Z (6 months ago)
• Topics: executable, file-watchers, javascript, nodejs
• Language: JavaScript
• Homepage:
• Size: 2.28 MB
• Stars: 540
• Watchers: 16
• Forks: 42
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

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

  }

}

```

History


Discover the release history by heading on over to the HISTORY.md file.

Contribute


Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers


Maintainers


These amazing people are maintaining this project:



Benjamin Lupton — view contributions



Sponsors


No sponsors yet! Will you be the first?



















Contributors


These amazing people have contributed code to this project:





Aaron O'Mullan — view contributions





Adam Sanderson — view contributions





Benjamin Lupton — view contributions





Casey Foster — view contributions



David Byrd



Fredrik Norén — view contributions





Josh Levine — view contributions





Robson Roberto Souza Peixoto — view contributions





Stuart Knightley — view contributions





Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License


Unless stated otherwise all works are:



Copyright © 2012+ Bevry Pty Ltd



Copyright © 2011 Benjamin Lupton





and licensed under:

MIT License