paulmillr

pipobscure

fsevents

  throw new Error(`Module 'fsevents' is not compatible with platform '${process.platform}'`);

const Native = require("./fsevents.node");

    throw new TypeError(`fsevents argument 1 must be a string and not a ${typeof path}`);

  if ("function" === typeof since && "undefined" === typeof handler) {

    throw new TypeError(`fsevents argument 2 must be a number and not a ${typeof since}`);

    throw new TypeError(`fsevents argument 3 must be a function and not a ${typeof handler}`);

  let instance = Native.start(Native.global, path, since, handler);

  if (!instance) throw new Error(`could not watch: ${path}`);

    const result = instance ? Promise.resolve(instance).then(Native.stop) : Promise.resolve(undefined);

  if (events.ItemIsFile & flags) return "file";

  if (events.ItemIsDir & flags) return "directory";

  if (events.MustScanSubDirs & flags) return "directory"; 

  if (events.ItemIsSymlink & flags) return "symlink";

  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";

    inode: !!(events.ItemInodeMetaMod & flags),

    finder: !!(events.ItemFinderInfoMod & flags),

    access: !!(events.ItemChangeOwner & flags),

    xattrs: !!(events.ItemXattrMod & flags),

  "description": "Native Access to MacOS FSEvents",

    "node": "^8.16.0 || ^10.6.0 || >=11.0.0"

    "clean": "node-gyp clean && rm -f fsevents.node",

    "build": "node-gyp clean && rm -f fsevents.node && node-gyp rebuild && node-gyp clean",

    "test": "/bin/bash ./test.sh 2>/dev/null",

    "url": "https://github.com/fsevents/fsevents.git"

    "url": "https://github.com/fsevents/fsevents/issues"

  "homepage": "https://github.com/fsevents/fsevents",

# fsevents [![NPM](https://nodei.co/npm/fsevents.png)](https://nodei.co/npm/fsevents/)

Native access to MacOS FSEvents in [Node.js](https://nodejs.org/)

The FSEvents API in MacOS allows applications to register for notifications of

changes to a given directory tree. It is a very fast and lightweight alternative

This is a low-level library. For a cross-platform file watching module that

uses fsevents, check out [Chokidar](https://github.com/paulmillr/chokidar).

Supports only **Node.js v8.16 and higher**.

const stop = fsevents.watch(__dirname, (path, flags, id) => {

  const info = fsevents.getInfo(path, flags, id);

  const info = fsevents.getInfo(path, flags);

> **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:

###### `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 which when called returns a Promise resolving when the watcher process has been shut down.

###### `fsevents.getInfo(path: string, flags: number, id: string): FsEventInfo`

The `getInfo` function takes the `path`, `flags` and `id` arguments and converts those parameters into a structure

that is easier to digest to determine what the change was.

The `FsEventsInfo` has the following shape:

 * @typedef {'created'|'modified'|'deleted'|'moved'|'root-changed'|'cloned'|'unknown'} FsEventsEvent

 * @typedef {'file'|'directory'|'symlink'} FsEventsType

    "inode": true,   // Had iNode Meta-Information changed

    "finder": false, // Had Finder Meta-Data changed

    "access": false, // Had access permissions changed

    "xattrs": false  // Had xAttributes changed

- v2 supports node 8.16+ and reduces package size massively

- 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.

Visit our [GitHub page](https://github.com/fsevents/fsevents) and [NPM Page](https://npmjs.org/package/fsevents)

		{
		"name": "fsevents",
		"version": "2.3.2",
		"version": "2.3.3",
		"description": "Native Access to MacOS FSEvents",
		@@ -60,4 +60,4 @@ "main": "fsevents.js",
		"devDependencies": {
		"node-gyp": "^6.1.0"
		"node-gyp": "^9.4.0"
		}
		}

		@@ -1,2 +0,2 @@
		# fsevents [![NPM](https://nodei.co/npm/fsevents.png)](https://nodei.co/npm/fsevents/)
		# fsevents

		@@ -12,6 +12,4 @@ Native access to MacOS FSEvents in [Node.js](https://nodejs.org/)

		## Installation
		## Usage

		Supports only Node.js v8.16 and higher.

		```sh
		@@ -21,12 +19,20 @@ 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
		@@ -33,0 +39,0 @@ a change in the file system. It takes three arguments:

		@@ -53,2 +53,3 @@ /*
		if (events.ItemIsDir & flags) return "directory";
		if (events.MustScanSubDirs & flags) return "directory";
		if (events.ItemIsSymlink & flags) return "symlink";
		@@ -55,0 +56,0 @@ }

Improved metrics