@photostructure/fs-metadata
Cross-platform native Node.js module for filesystem metadata, mount points, and volume information.
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);
Key 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: Full 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:20Docker image is not supported.
Documentation
- 📖 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-metafor debug output - Timeouts: Configure timeout duration for slow devices
- System Volumes: Control system volume filtering
Support
Built and supported by PhotoStructure