{"id":28475217,"url":"https://github.com/photostructure/fs-metadata","last_synced_at":"2026-04-01T16:51:36.993Z","repository":{"id":261890450,"uuid":"885645134","full_name":"photostructure/fs-metadata","owner":"photostructure","description":"Cross-platform native Node.js module for fetching filesystem metadata","archived":false,"fork":false,"pushed_at":"2026-03-27T04:12:46.000Z","size":3481,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-27T12:33:25.294Z","etag":null,"topics":["cjs","esm","filesystem","gio","linux","macos","metadata","mount","native","node-addon","nodejs","typescript","volume","windows"],"latest_commit_sha":null,"homepage":"https://photostructure.github.io/fs-metadata/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/photostructure.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-11-09T02:44:47.000Z","updated_at":"2026-03-27T04:12:49.000Z","dependencies_parsed_at":"2024-12-20T05:28:02.832Z","dependency_job_id":"0f936418-c985-4109-871b-b9881905fc32","html_url":"https://github.com/photostructure/fs-metadata","commit_stats":null,"previous_names":["photostructure/fs-metadata"],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/photostructure/fs-metadata","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/photostructure%2Ffs-metadata","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/photostructure%2Ffs-metadata/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/photostructure%2Ffs-metadata/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/photostructure%2Ffs-metadata/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/photostructure","download_url":"https://codeload.github.com/photostructure/fs-metadata/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/photostructure%2Ffs-metadata/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31290538,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T13:12:26.723Z","status":"ssl_error","status_checked_at":"2026-04-01T13:12:25.102Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cjs","esm","filesystem","gio","linux","macos","metadata","mount","native","node-addon","nodejs","typescript","volume","windows"],"created_at":"2025-06-07T14:05:44.454Z","updated_at":"2026-04-01T16:51:36.987Z","avatar_url":"https://github.com/photostructure.png","language":"TypeScript","readme":"\u003cimg src=\"https://raw.githubusercontent.com/photostructure/fs-metadata/main/doc/logo.svg\" alt=\"PhotoStructure fs-metadata logo\" width=\"200\"\u003e\n\nCross-platform native Node.js module for filesystem metadata, mount points, and volume information. Built for and supported by [PhotoStructure](https://photostructure.com).\n\n[![npm version](https://img.shields.io/npm/v/@photostructure/fs-metadata.svg)](https://www.npmjs.com/package/@photostructure/fs-metadata)\n[![Build](https://github.com/photostructure/fs-metadata/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/photostructure/fs-metadata/actions/workflows/build.yml)\n[![Node-API v9 Badge](https://raw.githubusercontent.com/nodejs/abi-stable-node/refs/heads/doc/assets/Node-API%20v9%20Badge.svg)](https://nodejs.org/dist/latest/docs/api/n-api.html#node-api-version-matrix)\n[![View on GitHub](https://img.shields.io/badge/View%20on-GitHub-blue)](https://github.com/photostructure/fs-metadata)\n\n## Quick start\n\n```bash\nnpm install @photostructure/fs-metadata\n```\n\n```typescript\nimport {\n  getVolumeMountPoints,\n  getVolumeMetadata,\n} from \"@photostructure/fs-metadata\";\n\n// List all mounted volumes\nconst mountPoints = await getVolumeMountPoints();\nconsole.log(mountPoints);\n\n// Get metadata for a specific volume\nconst metadata = await getVolumeMetadata(\"/\");\nconsole.log(metadata);\n```\n\n## Features\n\n- **Volume management**: List mount points, get volume metadata, space usage\n- **Hidden files**: Get/set hidden attributes, recursive checks, cross-platform support\n- **Performance**: Non-blocking async operations with timeout protection\n- **TypeScript**: Type definitions with ESM and CommonJS support\n\n## Supported platforms\n\n| Platform      | Architecture | Node.js | OS Version                |\n| ------------- | ------------ | ------- | ------------------------- |\n| Windows       | x64, arm64   | 20+     | Windows 10+               |\n| macOS         | x64, arm64   | 20+     | macOS 14+                 |\n| Linux (glibc) | x64, arm64   | 20+     | Debian 11+, Ubuntu 20.04+ |\n| Linux (musl)  | x64, arm64   | 20+     | Alpine 3.21+              |\n\n\u003e **Note**: Linux binaries require GLIBC 2.31+. The `node:20` Docker image is not supported.\n\n## Documentation\n\n- [Security reporting](./SECURITY.md) - How to report security issues\n- [API Reference](https://photostructure.github.io/fs-metadata/modules.html)\n- [Examples](./doc/examples.md) - Common usage patterns and recipes\n- [Gotchas](./doc/gotchas.md) - Platform quirks, timeouts, and troubleshooting\n- [Contributing](./CONTRIBUTING.md) - Build instructions and development guide\n\n### Options\n\n- **Debug**: Set `NODE_DEBUG=fs-meta` for debug output\n- **Timeouts**: Configure [timeout duration](https://photostructure.github.io/fs-metadata/functions/getTimeoutMsDefault.html) for slow devices\n  - Set `FS_METADATA_TIMEOUT_MS` environment variable to override the default (5000ms)\n- **System Volumes**: Control [system volume filtering](https://photostructure.github.io/fs-metadata/interfaces/Options.html)\n\n## Development\n\nDevelopment of this library was assisted by AI coding tools. All changes are human-reviewed and tested.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphotostructure%2Ffs-metadata","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphotostructure%2Ffs-metadata","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphotostructure%2Ffs-metadata/lists"}