Skip to content

Latest commit

 

History

History
74 lines (58 loc) · 2.8 KB

Readme.md

File metadata and controls

74 lines (58 loc) · 2.8 KB
Raw

FSEvents NPM

Native Access to Mac OS-X FSEvents

Installation

$ npm install -g node-gyp
$	git clone https://github.com/pipobscure/fsevents.git fsevents
$ cd fsevents
$ node-gyp configure build

OR SIMPLY

$ npm install fsevents

Usage

var fsevents = require('fsevents');
var watcher = fsevents(__dirname);
watcher.on('fsevent', function(path, flags, id) { }); // RAW Event as emitted by OS-X
watcher.on('change', function(path, info) {}); // Common Event for all changes
// To end observation

Events

  • fsevent - RAW Event as emitted by OS-X
  • change - Common Event for all changes
  • created - A File-System-Item has been created
  • deleted - A File-System-Item has been deleted
  • modified - A File-System-Item has been modified
  • moved-out - A File-System-Item has been moved away from this location
  • moved-in - A File-System-Item has been moved into this location

All events except fsevent take an info object as the second parameter of the callback. The structure of this object is:

{
  "event": "<event-type>",
  "id": <eventi-id>,
  "path": "<path-that-this-is-about>",
  "type": "<file|directory|symlink>",
  "changes": {
    "inode": true, // Has the iNode Meta-Information changed
    "finder": false, // Has the Finder Meta-Data changed
    "access": false, // Have the access permissions changed
    "xattrs": false // Have the xAttributes changed
  },
  "flags": <raw-flags>
}

MIT License

Copyright (C) 2010-2014 Philipp Dunkel

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.