@photostructure/fs-metadata 0.7.0 → 0.8.0

package/dist/index.d.mts

@@ -112,7 +112,7 @@ interface Options {
      *
      * Disable timeouts by setting this to 0.
      *
-     * @see {@link TimeoutMsDefault}.
+     * @see {@link getTimeoutMsDefault}.
      */
     timeoutMs: number;
     /**
@@ -242,12 +242,17 @@ type SetHiddenResult = {
 };
 
 /**
- * Default timeout in milliseconds for {@link Options.timeoutMs}.
+ * Get the default timeout in milliseconds for {@link Options.timeoutMs}.
+ *
+ * This can be overridden by setting the `FS_METADATA_TIMEOUT_MS` environment
+ * variable to a positive integer.
  *
  * Note that this timeout may be insufficient for some devices, like spun-down
  * optical drives or network shares that need to spin up or reconnect.
+ *
+ * @returns The timeout from env var if valid, otherwise 5000ms
  */
-declare const TimeoutMsDefault: 5000;
+declare function getTimeoutMsDefault(): number;
 /**
  * System paths and globs that indicate system volumes
  */
@@ -313,7 +318,7 @@ declare function getVolumeMetadata(mountPoint: string, opts?: Partial<Pick<Optio
  * {@link https://nodejs.org/api/os.html#osavailableparallelism | os.availableParallelism()}
  * @param opts.timeoutMs - Maximum time to wait for
  * {@link getVolumeMountPointsImpl}, as well as **each** {@link getVolumeMetadataImpl}
- * to complete. Defaults to {@link TimeoutMsDefault}
+ * to complete. Defaults to {@link getTimeoutMsDefault}
  * @returns Promise that resolves to an array of either VolumeMetadata objects
  * or error objects containing the mount point and error
  * @throws Never - errors are caught and returned as part of the result array
@@ -362,4 +367,4 @@ declare function getHiddenMetadata(pathname: string): Promise<HiddenMetadata>;
  */
 declare function setHidden(pathname: string, hidden: boolean, method?: HideMethod): Promise<SetHiddenResult>;
 
-export { type GetVolumeMountPointOptions, type HiddenMetadata, type HideMethod, IncludeSystemVolumesDefault, LinuxMountTablePathsDefault, type MountPoint, type Options, OptionsDefault, type SetHiddenResult, type StringEnum, type StringEnumKeys, type StringEnumType, SystemFsTypesDefault, SystemPathPatternsDefault, type SystemVolumeConfig, TimeoutMsDefault, type VolumeHealthStatus, VolumeHealthStatuses, type VolumeMetadata, getAllVolumeMetadata, getHiddenMetadata, getVolumeMetadata, getVolumeMountPoints, isHidden, isHiddenRecursive, optionsWithDefaults, setHidden };
+export { type GetVolumeMountPointOptions, type HiddenMetadata, type HideMethod, IncludeSystemVolumesDefault, LinuxMountTablePathsDefault, type MountPoint, type Options, OptionsDefault, type SetHiddenResult, type StringEnum, type StringEnumKeys, type StringEnumType, SystemFsTypesDefault, SystemPathPatternsDefault, type SystemVolumeConfig, type VolumeHealthStatus, VolumeHealthStatuses, type VolumeMetadata, getAllVolumeMetadata, getHiddenMetadata, getTimeoutMsDefault, getVolumeMetadata, getVolumeMountPoints, isHidden, isHiddenRecursive, optionsWithDefaults, setHidden };

package/dist/index.d.ts

@@ -112,7 +112,7 @@ interface Options {
      *
      * Disable timeouts by setting this to 0.
      *
-     * @see {@link TimeoutMsDefault}.
+     * @see {@link getTimeoutMsDefault}.
      */
     timeoutMs: number;
     /**
@@ -242,12 +242,17 @@ type SetHiddenResult = {
 };
 
 /**
- * Default timeout in milliseconds for {@link Options.timeoutMs}.
+ * Get the default timeout in milliseconds for {@link Options.timeoutMs}.
+ *
+ * This can be overridden by setting the `FS_METADATA_TIMEOUT_MS` environment
+ * variable to a positive integer.
  *
  * Note that this timeout may be insufficient for some devices, like spun-down
  * optical drives or network shares that need to spin up or reconnect.
+ *
+ * @returns The timeout from env var if valid, otherwise 5000ms
  */
-declare const TimeoutMsDefault: 5000;
+declare function getTimeoutMsDefault(): number;
 /**
  * System paths and globs that indicate system volumes
  */
@@ -313,7 +318,7 @@ declare function getVolumeMetadata(mountPoint: string, opts?: Partial<Pick<Optio
  * {@link https://nodejs.org/api/os.html#osavailableparallelism | os.availableParallelism()}
  * @param opts.timeoutMs - Maximum time to wait for
  * {@link getVolumeMountPointsImpl}, as well as **each** {@link getVolumeMetadataImpl}
- * to complete. Defaults to {@link TimeoutMsDefault}
+ * to complete. Defaults to {@link getTimeoutMsDefault}
  * @returns Promise that resolves to an array of either VolumeMetadata objects
  * or error objects containing the mount point and error
  * @throws Never - errors are caught and returned as part of the result array
@@ -362,4 +367,4 @@ declare function getHiddenMetadata(pathname: string): Promise<HiddenMetadata>;
  */
 declare function setHidden(pathname: string, hidden: boolean, method?: HideMethod): Promise<SetHiddenResult>;
 
-export { type GetVolumeMountPointOptions, type HiddenMetadata, type HideMethod, IncludeSystemVolumesDefault, LinuxMountTablePathsDefault, type MountPoint, type Options, OptionsDefault, type SetHiddenResult, type StringEnum, type StringEnumKeys, type StringEnumType, SystemFsTypesDefault, SystemPathPatternsDefault, type SystemVolumeConfig, TimeoutMsDefault, type VolumeHealthStatus, VolumeHealthStatuses, type VolumeMetadata, getAllVolumeMetadata, getHiddenMetadata, getVolumeMetadata, getVolumeMountPoints, isHidden, isHiddenRecursive, optionsWithDefaults, setHidden };
+export { type GetVolumeMountPointOptions, type HiddenMetadata, type HideMethod, IncludeSystemVolumesDefault, LinuxMountTablePathsDefault, type MountPoint, type Options, OptionsDefault, type SetHiddenResult, type StringEnum, type StringEnumKeys, type StringEnumType, SystemFsTypesDefault, SystemPathPatternsDefault, type SystemVolumeConfig, type VolumeHealthStatus, VolumeHealthStatuses, type VolumeMetadata, getAllVolumeMetadata, getHiddenMetadata, getTimeoutMsDefault, getVolumeMetadata, getVolumeMountPoints, isHidden, isHiddenRecursive, optionsWithDefaults, setHidden };

package/dist/index.mjs

@@ -571,7 +571,14 @@ async function setHiddenImpl(pathname, hide, method, nativeFn2) {
 
 // src/options.ts
 import { availableParallelism as availableParallelism2 } from "os";
-var TimeoutMsDefault = 5e3;
+import { env as env2 } from "process";
+var DefaultTimeoutMs = 5e3;
+function getTimeoutMsDefault() {
+  const value = env2["FS_METADATA_TIMEOUT_MS"];
+  if (value == null) return DefaultTimeoutMs;
+  const parsed = parseInt(value, 10);
+  return Number.isFinite(parsed) && parsed > 0 ? parsed : DefaultTimeoutMs;
+}
 var SystemPathPatternsDefault = [
   "/boot",
   "/boot/efi",
@@ -640,7 +647,7 @@ var LinuxMountTablePathsDefault = [
 var IncludeSystemVolumesDefault = isWindows;
 var SkipNetworkVolumesDefault = false;
 var OptionsDefault = {
-  timeoutMs: TimeoutMsDefault,
+  timeoutMs: getTimeoutMsDefault(),
   maxConcurrency: availableParallelism2(),
   systemPathPatterns: [...SystemPathPatternsDefault],
   systemFsTypes: [...SystemFsTypesDefault],
@@ -1414,10 +1421,10 @@ export {
   OptionsDefault,
   SystemFsTypesDefault,
   SystemPathPatternsDefault,
-  TimeoutMsDefault,
   VolumeHealthStatuses,
   getAllVolumeMetadata,
   getHiddenMetadata,
+  getTimeoutMsDefault,
   getVolumeMetadata,
   getVolumeMountPoints,
   isHidden,