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() 。