@electron/fsevents

中文文档
2.3.3-fork发布于 2026/04/07MITTypeScriptCommonJS零依赖构建来源已验证近 30 天下载 1.3万

本地访问 MacOS FSEvents

中文使用文档
文档目录4 节
  1. 使用量
  2. 更改日志
  3. 解决问题
  4. 许可证

条纹

本地访问 MacOS FSEvents in 节点.js

MacOS中的FSEvents API允许应用程序注册通知 更改给定目录树。 这是一个非常快和轻量级的替代品 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}去排队.

这是一个低层的图书馆。 用于跨平台文件监视模块 使用fenets,检查 乔基达尔。 。 。 .

使用量

npm install fsevents

仅支持 节点.js v8.16及以上。 。 。 .

const fsevents = require('fsevents');

// To start observation
const stop = fsevents.watch(__dirname, (path, flags, id) => {
  const info = fsevents.getInfo(path, flags);
});

// To end observation
stop();

重要说明: API的行为与典型的JS API略有不同. 这个 stop 函数 必须 为: 即使你不打算阻止监视者 也要找到并存放在某个地方 如果你忘了, 垃圾收集器 最终会踢入, 监视者将是不注册的, 和你召回 不再呼叫.

调用为第二个参数 .watch 只要操作系统发现 文件系统的更改。 这需要三个论点:

fsevents.watch(dirname: string, (path: string, flags: number, id: string) => void): () => Promise<undefined>
  • path: string - 文件系统中已更改的项目
  • flags: number - 描述变化的数值
  • id: string - 确定这一具体事件的独特身份

返回更紧密的回调, 当被调用为“ 返回承诺” 时, 当监视器进程被关闭时, 返回“ 返回承诺” .

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

这个 getInfo 函数取 path, (中文(简体) ), flags 财务报告和审定财务报表 id 参数并将其转换为结构 比较容易消化 以确定是什么变化.

这个 FsEventsInfo 形状如下:

/**
 * @typedef {'created'|'modified'|'deleted'|'moved'|'root-changed'|'cloned'|'unknown'} FsEventsEvent
 * @typedef {'file'|'directory'|'symlink'} FsEventsType
 */
{
  "event": "created", // {FsEventsEvent}
  "path": "file.txt",
  "type": "file",    // {FsEventsType}
  "changes": {
    "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
  },
  "flags": 0x100000000
}

更改日志

  • v2.3 支持苹果硅ARM CPU
  • v2 支持节点8. 16+并大规模缩小包大小
  • v1.2.8 支持节点 6+
  • v1.2.7 支持节点 4+

解决问题

  • 我开始 EBADPLATFORM Unsupported platform for fsevents 错误.
  • 没事,没事的 FF77Ts是只马可斯。 其他平台被跳过 。 如果您想要隐藏此警告, 请向 NPA 错误跟踪器报告一个错误, 要求他们默认隐藏错误平台警告 .

许可证

MIT许可版权(C) 2010-2020 由菲利普·邓克尔(Philipp Dunkel),本·诺德怀斯(Ben Noordhuis),埃兰·尚卡尔(Elan Shankar),保罗·米勒(Paul Miller)所著——参见LICENSE文件.

拜访我们 GitHub 页面 财务报告和审定财务报表 国家预防机制

版本与发布记录

@electron/fsevents 共发布 2 个版本,首次发布于 2026/04/07;过去 12 个月发布了 2 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.3.3-forklatest2026/04/077 个月前
0.0.02026/04/077 个月前

关于 @electron/fsevents 的常见问题

@electron/fsevents 是什么?

本地访问 MacOS FSEvents

如何安装 @electron/fsevents?

在项目目录运行 npm install @electron/fsevents,或使用 pnpm add / yarn add / bun add。

@electron/fsevents 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@electron/fsevents 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@electron/fsevents 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js ^8.16.0 || ^10.6.0 || >=11.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@electron/fsevents 可以商用吗?

@electron/fsevents 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@electron/fsevents 的下载量有多少?

根据 npm 官方下载统计,@electron/fsevents 在 2026/10/14 – 2026/11/12 这 30 天内被下载 12,970 次,日均约 432 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@electron/fsevents 还在维护吗?

最新版本 2.3.3-fork 发布于 2026/04/07(7 个月前);至今共发布 2 个版本,其中过去 12 个月发布了 2 个;首次发布于 2026/04/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。