fsevents 2.3.1 → 2.3.3

package/README.md

@@ -1,4 +1,4 @@
-# fsevents [![NPM](https://nodei.co/npm/fsevents.png)](https://nodei.co/npm/fsevents/)
+# fsevents
 
 Native access to MacOS FSEvents in [Node.js](https://nodejs.org/)
 
@@ -9,24 +9,30 @@ to kqueue.
 This is a low-level library. For a cross-platform file watching module that
 uses fsevents, check out [Chokidar](https://github.com/paulmillr/chokidar).
 
-## Installation
-
-Supports only **Node.js v8.16 and higher**.
+## Usage
 
 ```sh
 npm install fsevents
 ```
 
-## Usage
+Supports only **Node.js v8.16 and higher**.
 
 ```js
 const fsevents = require('fsevents');
+
+// To start observation
 const stop = fsevents.watch(__dirname, (path, flags, id) => {
-  const info = fsevents.getInfo(path, flags, id);
-}); // To start observation
-stop(); // To end observation
+  const info = fsevents.getInfo(path, flags);
+});
+
+// To end observation
+stop();
 ```
 
+> **Important note:** The API behaviour is slightly different from typical JS APIs. The `stop` function **must** be
+> retrieved and stored somewhere, even if you don't plan to stop the watcher. If you forget it, the garbage collector
+> will eventually kick in, the watcher will be unregistered, and your callbacks won't be called anymore.
+
 The callback passed as the second parameter to `.watch` get's called whenever the operating system detects a
 a change in the file system. It takes three arguments:
 

package/fsevents.js

@@ -50,6 +50,7 @@ function getInfo(path, flags) {
 function getFileType(flags) {
   if (events.ItemIsFile & flags) return "file";
   if (events.ItemIsDir & flags) return "directory";
+  if (events.MustScanSubDirs & flags) return "directory"; 
   if (events.ItemIsSymlink & flags) return "symlink";
 }
 function anyIsTrue(obj) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fsevents",
-  "version": "2.3.1",
+  "version": "2.3.3",
   "description": "Native Access to MacOS FSEvents",
   "main": "fsevents.js",
   "types": "fsevents.d.ts",
@@ -57,6 +57,6 @@
   },
   "homepage": "https://github.com/fsevents/fsevents",
   "devDependencies": {
-    "node-gyp": "^6.1.0"
+    "node-gyp": "^9.4.0"
   }
 }