fsevents 2.1.1 → 2.2.1

package/LICENSE

@@ -1,7 +1,7 @@
 MIT License
 -----------
 
-Copyright (C) 2010-2019 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller
+Copyright (C) 2010-2020 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -30,13 +30,13 @@ stop(); // To end observation
 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:
 
-###### `fsevents.watch(dirname: string, (path: string, flags: number, id: string) => void): Function`
+###### `fsevents.watch(dirname: string, (path: string, flags: number, id: string) => void): () => Promise<undefined>`
 
  * `path: string` - the item in the filesystem that have been changed
  * `flags: number` - a numeric value describing what the change was
  * `id: string` - an unique-id identifying this specific event
- 
- Returns closer callback.
+
+ Returns closer callback which when called returns a Promise resolving when the watcher process has been shut down.
 
 ###### `fsevents.getInfo(path: string, flags: number, id: string): FsEventInfo`
 
@@ -47,12 +47,12 @@ The `FsEventsInfo` has the following shape:
 
 ```js
 /**
- * @typedef {'created'|'modified'|'deleted'|'moved'|'root-changed'|'unknown'} FsEventsEvent
+ * @typedef {'created'|'modified'|'deleted'|'moved'|'root-changed'|'cloned'|'unknown'} FsEventsEvent
  * @typedef {'file'|'directory'|'symlink'} FsEventsType
  */
 {
-  "event": "created",
-  "path": "file.txt", // {FsEventsEvent}
+  "event": "created", // {FsEventsEvent}
+  "path": "file.txt", 
   "type": "file",    // {FsEventsType}
   "changes": {
     "inode": true,   // Had iNode Meta-Information changed
@@ -64,8 +64,19 @@ The `FsEventsInfo` has the following shape:
 }
 ```
 
+## Engine compatibility
+
+- v2 supports node 8.16+
+- v1.2.8 supports node 6+
+- v1.2.7 supports node 4+
+
+## Troubleshooting
+
+- I'm getting `EBADPLATFORM` `Unsupported platform for fsevents` error.
+- It's fine, nothing is broken. fsevents is macos-only. Other platforms are skipped. If you want to hide this warning, report a bug to NPM bugtracker asking them to hide ebadplatform warnings by default.
+
 ## License
 
-The MIT License Copyright (C) 2010-2019 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller — see LICENSE file.
+The MIT License Copyright (C) 2010-2020 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller — see LICENSE file.
 
 Visit our [GitHub page](https://github.com/fsevents/fsevents) and [NPM Page](https://npmjs.org/package/fsevents)

package/fsevents.d.ts

@@ -0,0 +1,46 @@
+declare type Event = "created" | "cloned" | "modified" | "deleted" | "moved" | "root-changed" | "unknown";
+declare type Type = "file" | "directory" | "symlink";
+declare type FileChanges = {
+  inode: boolean;
+  finder: boolean;
+  access: boolean;
+  xattrs: boolean;
+};
+declare type Info = {
+  event: Event;
+  path: string;
+  type: Type;
+  changes: FileChanges;
+  flags: number;
+};
+declare type WatchHandler = (path: string, flags: number, id: string) => void;
+export declare function watch(path: string, handler: WatchHandler): () => Promise<void>;
+export declare function watch(path: string, since: number, handler: WatchHandler);
+export declare function getInfo(path: string, flags: number): Info;
+export declare const constants: {
+  None: 0x00000000;
+  MustScanSubDirs: 0x00000001;
+  UserDropped: 0x00000002;
+  KernelDropped: 0x00000004;
+  EventIdsWrapped: 0x00000008;
+  HistoryDone: 0x00000010;
+  RootChanged: 0x00000020;
+  Mount: 0x00000040;
+  Unmount: 0x00000080;
+  ItemCreated: 0x00000100;
+  ItemRemoved: 0x00000200;
+  ItemInodeMetaMod: 0x00000400;
+  ItemRenamed: 0x00000800;
+  ItemModified: 0x00001000;
+  ItemFinderInfoMod: 0x00002000;
+  ItemChangeOwner: 0x00004000;
+  ItemXattrMod: 0x00008000;
+  ItemIsFile: 0x00010000;
+  ItemIsDir: 0x00020000;
+  ItemIsSymlink: 0x00040000;
+  ItemIsHardlink: 0x00100000;
+  ItemIsLastHardlink: 0x00200000;
+  OwnEvent: 0x00080000;
+  ItemCloned: 0x00400000;
+};
+export {};

package/fsevents.js

@@ -1,31 +1,38 @@
 /*
- ** © 2018 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller
+ ** © 2020 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller
  ** Licensed under MIT License.
  */
 
 /* jshint node:true */
-'use strict';
+"use strict";
 
-if (process.platform !== 'darwin') {
+if (process.platform !== "darwin") {
   throw new Error(`Module 'fsevents' is not compatible with platform '${process.platform}'`);
 }
 
-const Native = require('./fsevents.node');
+const Native = require("./fsevents.node");
 const events = Native.constants;
 
-function watch(path, handler) {
-  if (typeof path !== 'string') {
+function watch(path, since, handler) {
+  if (typeof path !== "string") {
     throw new TypeError(`fsevents argument 1 must be a string and not a ${typeof path}`);
   }
-  if (typeof handler !== 'function') {
-    throw new TypeError(`fsevents argument 2 must be a function and not a ${typeof handler}`);
+  if ("function" === typeof since && "undefined" === typeof handler) {
+    handler = since;
+    since = Native.flags.SinceNow;
+  }
+  if (typeof since !== "number") {
+    throw new TypeError(`fsevents argument 2 must be a number and not a ${typeof since}`);
+  }
+  if (typeof handler !== "function") {
+    throw new TypeError(`fsevents argument 3 must be a function and not a ${typeof handler}`);
   }
 
-  let instance = Native.start(path, handler);
+  let instance = Native.start(Native.global, path, since, handler);
   if (!instance) throw new Error(`could not watch: ${path}`);
   return () => {
-    const result = instance ? Promise.resolve(instance).then(Native.stop) : null;
-    instance = null;
+    const result = instance ? Promise.resolve(instance).then(Native.stop) : Promise.resolve(undefined);
+    instance = undefined;
     return result;
   };
 }
@@ -36,14 +43,14 @@ function getInfo(path, flags) {
     flags,
     event: getEventType(flags),
     type: getFileType(flags),
-    changes: getFileChanges(flags)
+    changes: getFileChanges(flags),
   };
 }
 
 function getFileType(flags) {
-  if (events.ItemIsFile & flags) return 'file';
-  if (events.ItemIsDir & flags) return 'directory';
-  if (events.ItemIsSymlink & flags) return 'symlink';
+  if (events.ItemIsFile & flags) return "file";
+  if (events.ItemIsDir & flags) return "directory";
+  if (events.ItemIsSymlink & flags) return "symlink";
 }
 function anyIsTrue(obj) {
   for (let key in obj) {
@@ -52,21 +59,21 @@ function anyIsTrue(obj) {
   return false;
 }
 function getEventType(flags) {
-  if (events.ItemRemoved & flags) return 'deleted';
-  if (events.ItemRenamed & flags) return 'moved';
-  if (events.ItemCreated & flags) return 'created';
-  if (events.ItemModified & flags) return 'modified';
-  if (events.RootChanged & flags) return 'root-changed';
-  if (events.ItemCloned & flags) return 'cloned';
-  if (anyIsTrue(flags)) return 'modified';
-  return 'unknown';
+  if (events.ItemRemoved & flags) return "deleted";
+  if (events.ItemRenamed & flags) return "moved";
+  if (events.ItemCreated & flags) return "created";
+  if (events.ItemModified & flags) return "modified";
+  if (events.RootChanged & flags) return "root-changed";
+  if (events.ItemCloned & flags) return "cloned";
+  if (anyIsTrue(flags)) return "modified";
+  return "unknown";
 }
 function getFileChanges(flags) {
   return {
     inode: !!(events.ItemInodeMetaMod & flags),
     finder: !!(events.ItemFinderInfoMod & flags),
     access: !!(events.ItemChangeOwner & flags),
-    xattrs: !!(events.ItemXattrMod & flags)
+    xattrs: !!(events.ItemXattrMod & flags),
   };
 }
 

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "fsevents",
-  "version": "2.1.1",
+  "version": "2.2.1",
   "description": "Native Access to MacOS FSEvents",
   "main": "fsevents.js",
+  "types": "fsevents.d.ts",
   "os": [
     "darwin"
   ],
-  "files": ["fsevents.js", "fsevents.node"],
+  "files": [
+    "fsevents.d.ts",
+    "fsevents.js",
+    "fsevents.node"
+  ],
   "engines": {
     "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
   },
@@ -50,5 +55,8 @@
   "bugs": {
     "url": "https://github.com/fsevents/fsevents/issues"
   },
-  "homepage": "https://github.com/fsevents/fsevents"
+  "homepage": "https://github.com/fsevents/fsevents",
+  "devDependencies": {
+    "node-gyp": "^6.1.0"
+  }
 }