fsevents 2.1.1 → 2.1.2

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,7 +47,7 @@ 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
  */
 {
@@ -64,6 +64,12 @@ 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+
+
 ## License
 
 The MIT License Copyright (C) 2010-2019 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller — see LICENSE file.

package/fsevents.d.ts

@@ -0,0 +1,55 @@
+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 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

@@ -24,8 +24,10 @@ function watch(path, handler) {
   let instance = Native.start(path, 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;
   };
 }

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "fsevents",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "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"
   },