paulmillr

pipobscure

fsevents

declare type Type = "file" | "directory" | "symlink";

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 watch(path: string, since: number, handler: WatchHandler): () => Promise<void>;

export declare function getInfo(path: string, flags: number): Info;

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

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

- 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.2.1",
		"version": "2.2.2",
		"description": "Native Access to MacOS FSEvents",
		@@ -5,0 +5,0 @@ "main": "fsevents.js",

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

		- v2.3 supports Apple Silicon ARM CPUs
		- v2 supports node 8.16+
		@@ -71,0 +72,0 @@ - v1.2.8 supports node 6+

		@@ -18,3 +18,3 @@ declare type Event = "created" \| "cloned" \| "modified" \| "deleted" \| "moved" \| "root-changed" \| "unknown";
		export declare function watch(path: string, handler: WatchHandler): () => Promise<void>;
		export declare function watch(path: string, since: number, handler: WatchHandler);
		export declare function watch(path: string, since: number, handler: WatchHandler): () => Promise<void>;
		export declare function getInfo(path: string, flags: number): Info;
		@@ -21,0 +21,0 @@ export declare const constants: {

Improved metrics