@photostructure/fs-metadata

A cross-platform native Node.js module for retrieving filesystem metadata, including mount points, volume information, and space utilization statistics.

Built and supported by PhotoStructure.

Features

• Cross-platform support:

  • Windows 10+ (x64, arm64)
  • macOS 14+ (x64, arm64)
  • Ubuntu 22+ (x64, arm64) (with Gnome GIO/GVfs mount support when available)

• List all mounted volumes/drives

• Get detailed volume metadata

• File and directory hidden attribute support:

  • Get and set hidden attributes
  • POSIX-style support (macOS and Linux)
  • Filesystem metadata support (macOS and Windows)
  • Recursive hidden checks
  • Hidden metadata queries

• ESM and CJS support

• Full TypeScript type definitions

• Non-blocking async native implementations

• Timeout handling for wedged network volumes

• Compatible with all current Node.js and Electron versions via Node-API v9 and prebuildify

• Comprehensive test coverage

Installation

npm install @photostructure/fs-metadata
Copy

Usage

import {
  getVolumeMountPoints,
  getVolumeMetadata,
} from "@photostructure/fs-metadata";

// List all mounted volumes
const mountPoints = await getVolumeMountPoints();
console.dir({ mountPoints });

// Get metadata for a specific volume
const volumeMetadata = await getVolumeMetadata(mountPoints[0]);
console.dir({ volumeMetadata });
Copy

If you're using CommonJS:

const {
  getVolumeMountPoints,
  getVolumeMetadata,
} = require("@photostructure/fs-metadata");

// Usage is the same as the ESM example above 
// (except of course no top-level awaits!)
Copy

API

Read the API here

Options

Debug Logging

Set NODE_DEBUG=fs-meta or NODE_DEBUG=photostructure:fs-metadata. The native debuglog determines if debug logging is enabled. Debug messages from both JavaScript and native code are sent to stderr.

Timeouts

Operations use a default timeout, which may need adjustment for slower devices like optical drives (which can take 30+ seconds to spin up).

Windows can block system calls when remote filesystems are unhealthy due to host downtime or network issues. To handle this, we use a separate thread per mountpoint to check volume health status. While this approach uses more resources than the async N-API thread, it enables reliable timeouts for operations that would otherwise hang indefinitely.

Timeout duration may apply per-operation or per-system call, depending on the implementation.

System Volumes

Each platform handles system volumes differently:

• Windows provides explicit metadata for "system" or "reserved" devices, though C: is both a system volume and typical user storage
• Linux and macOS include various system-only mountpoints: pseudo devices, snap loopback devices, virtual memory partitions, and recovery partitions

This library uses heuristics to identify system volumes. See Options for default values and customization.

Note: getAllVolumeMetadata() returns all volumes on Windows but only non-system volumes elsewhere by default.

Platform-Specific Behaviors

This module's results are inherently platform-specific. Here are some things to keep in mind:

Mount Points

Windows

• Mount points are drive letters with trailing backslash (e.g., C:\, D:)
• Network shares appear as mounted drives with UNC paths
• Volume GUIDs are available through Windows API
• Hidden and system volumes may be included

macOS

• Uses forward slashes for paths (e.g., /, /Users)
• Volume UUIDs may be available through the DiskArbitration framework
• Time Machine volumes should be detected and handled appropriately

Linux

• Uses forward slashes for paths (e.g., /, /home)
• Network mounts (NFS/CIFS) handled through mount table
• If GIO support is installed, it will be queried for additional mountpoints and volume metadata
• Depending on your distribution, you may want to use { linuxMountTablePath: "/etc/mtab" } instead of the default, /proc/mounts.
• UUID detection is via libblkid, which must be installed.

Volume Metadata

Windows

• Volume status from GetDriveType
• Size information from GetDiskFreeSpaceEx
• Volume information (label, filesystem) from GetVolumeInformation
• fstype will be NTFS for remote filesystems, as that's how Windows presents the local volume. Fixing this to be more accurate requires additional heuristics that have diminshing returns.
• The UUID is attempted to be extracted from the partition UUID, but if this is a remote volume, or system permissions do not provide access to this, we will fall back to returning the volume serial number that the operating system assigns. You can tell that it's a serial number UUID in that it only contains 8 characters (32 bits of entropy).

macOS

• Size calculations via statvfs
• Volume details through DiskArbitration framework
• Network share detection via volume characteristics

Linux

• Size information from statvfs
• Filesystem type from mount table and from gio
• Block device metadata via libblkid
• Network filesystem detection from mount options
• Optional GIO integration for additional metadata
• Backfills with lsblk metadata if native code fails

License

MIT

Contributing

See CONTRIBUTING.md on GitHub.

Security

See SECURITY.md on GitHub.