Node.js fsPromises.watch(filename[, options])用法及代码示例

fsPromises.watch(filename[, options])

参数

• filename <string> | <Buffer> | <URL>
• options <string>|<Object>
  • persistent <boolean> 指示只要正在监视文件，进程是否应继续运行。 默认： true 。
  • recursive <boolean> 指示是应监视所有子目录，还是仅监视当前目录。这适用于指定目录时，并且仅适用于受支持的平台(请参阅caveats)。 默认： false 。
  • encoding <string> 指定用于传递给侦听器的文件名的字符编码。 默认： 'utf8' 。
  • signal <AbortSignal> <AbortSignal> 用于指示观察者何时应该停止。
• 返回：<AsyncIterator>具有以下属性的对象：
  • eventType <string> 变更类型
  • filename <string> | <Buffer> 文件名已更改。

返回一个异步迭代器，它监视 filename 上的更改，其中 filename 是文件或目录。

const { watch } = require('node:fs/promises');

const ac = new AbortController();
const { signal } = ac;
setTimeout(() => ac.abort(), 10000);

(async () => {
  try {
    const watcher = watch(__filename, { signal });
    for await (const event of watcher)
      console.log(event);
  } catch (err) {
    if (err.name === 'AbortError')
      return;
    throw err;
  }
})();

在大多数平台上，只要文件名在目录中出现或消失，就会发出'rename'。

fs.watch() 的所有 caveats 也适用于 fsPromises.watch() 。