Cross-platform native Node.js module for filesystem metadata, mount points, and volume information. Built for and supported by PhotoStructure.

Quick start

npm install @photostructure/fs-metadata

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

// List all mounted volumes
const mountPoints = await getVolumeMountPoints();
console.log(mountPoints);

// Get metadata for a specific volume
const metadata = await getVolumeMetadata("/");
console.log(metadata);

Features

• Volume management: List mount points, get volume metadata, space usage
• Hidden files: Get/set hidden attributes, recursive checks, cross-platform support
• Performance: Non-blocking async operations with timeout protection
• TypeScript: Type definitions with ESM and CommonJS support

Supported platforms

| Platform | Architecture | Node.js | OS Version | | ------------- | ------------ | ------- | ------------------------- | | Windows | x64, arm64 | 20+ | Windows 10+ | | macOS | x64, arm64 | 20+ | macOS 14+ | | Linux (glibc) | x64, arm64 | 20+ | Debian 11+, Ubuntu 20.04+ | | Linux (musl) | x64, arm64 | 20+ | Alpine 3.21+ |

Note: Linux binaries require GLIBC 2.31+. The node:20 Docker image is not supported.

Documentation

• Security reporting - How to report security issues
• API Reference
• Examples - Common usage patterns and recipes
• Gotchas - Platform quirks, timeouts, and troubleshooting
• Contributing - Build instructions and development guide

Options

• Debug: Set NODE_DEBUG=fs-meta for debug output
• Timeouts: Configure timeout duration for slow devices
  • Set FS_METADATA_TIMEOUT_MS environment variable to override the default (5000ms)
• System Volumes: Control system volume filtering

Development

Development of this library was assisted by AI coding tools. All changes are human-reviewed and tested.