@jsenv/filesystem 4.10.13 → 4.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/filesystem",
-  "version": "4.10.13",
+  "version": "4.11.0",
   "license": "MIT",
   "repository": {
     "type": "git",

package/src/lifecycle/call_once_idle.js

@@ -0,0 +1,32 @@
+export const callOnceIdle = (callback, idleMs) => {
+  let timeoutId;
+  return (...args) => {
+    if (timeoutId) {
+      clearTimeout(timeoutId);
+    }
+    timeoutId = setTimeout(() => {
+      callback(...args);
+    }, idleMs);
+    if (timeoutId.unref) {
+      timeoutId.unref();
+    }
+  };
+};
+
+export const callOnceIdlePerFile = (callback, idleMs) => {
+  const timeoutIdMap = new Map();
+  return (fileEvent) => {
+    const { relativeUrl } = fileEvent;
+    let timeoutId = timeoutIdMap.get(relativeUrl);
+    if (timeoutId) {
+      clearTimeout(timeoutId);
+    }
+    timeoutId = setTimeout(() => {
+      callback(fileEvent);
+    }, idleMs);
+    if (timeoutId.unref) {
+      timeoutId.unref();
+    }
+    timeoutIdMap.set(relativeUrl, timeoutId);
+  };
+};

package/src/lifecycle/register_directory_lifecycle.js

@@ -4,6 +4,7 @@ import { readdirSync } from "node:fs";
 import { assertAndNormalizeDirectoryUrl } from "../path_and_url/directory_url_validation.js";
 import { readEntryStatSync } from "../read_write/stat/read_entry_stat_sync.js";
 import { statsToType } from "../read_write/stat/stats_to_type.js";
+import { callOnceIdlePerFile } from "./call_once_idle.js";
 import { createWatcher } from "./create_watcher.js";
 import { guardTooFastSecondCallPerFile } from "./guard_second_call.js";
 import { trackResources } from "./track_resources.js";
@@ -30,6 +31,7 @@ export const registerDirectoryLifecycle = (
     // For this reason"cooldownBetweenFileEvents" should be reserved to scenarios
     // like unit tests
     cooldownBetweenFileEvents = 0,
+    idleMs = 50,
   },
 ) => {
   const sourceUrl = assertAndNormalizeDirectoryUrl(source);
@@ -46,6 +48,11 @@ export const registerDirectoryLifecycle = (
       `removed must be a function or undefined, got ${removed}`,
     );
   }
+  if (idleMs) {
+    if (updated) {
+      updated = callOnceIdlePerFile(updated, idleMs);
+    }
+  }
   if (cooldownBetweenFileEvents) {
     if (added) {
       added = guardTooFastSecondCallPerFile(added, cooldownBetweenFileEvents);

package/src/lifecycle/register_file_lifecycle.js

@@ -3,6 +3,7 @@ import { basename, dirname } from "node:path";
 import { assertAndNormalizeFileUrl } from "../path_and_url/file_url_validation.js";
 import { readEntryStatSync } from "../read_write/stat/read_entry_stat_sync.js";
 import { statsToType } from "../read_write/stat/stats_to_type.js";
+import { callOnceIdle } from "./call_once_idle.js";
 import { createWatcher } from "./create_watcher.js";
 import { guardTooFastSecondCall } from "./guard_second_call.js";
 import { trackResources } from "./track_resources.js";
@@ -16,6 +17,7 @@ export const registerFileLifecycle = (
     notifyExistent = false,
     keepProcessAlive = true,
     cooldownBetweenFileEvents = 0,
+    idleMs = 50,
   },
 ) => {
   const sourceUrl = assertAndNormalizeFileUrl(source);
@@ -32,6 +34,11 @@ export const registerFileLifecycle = (
       `removed must be a function or undefined, got ${removed}`,
     );
   }
+  if (idleMs) {
+    if (updated) {
+      updated = callOnceIdle(updated, idleMs);
+    }
+  }
   if (cooldownBetweenFileEvents) {
     if (added) {
       added = guardTooFastSecondCall(added, cooldownBetweenFileEvents);