{"id":17086334,"url":"https://github.com/alex-d/check-disk-space","last_synced_at":"2025-04-12T18:44:56.991Z","repository":{"id":44867302,"uuid":"105217988","full_name":"Alex-D/check-disk-space","owner":"Alex-D","description":"Light multi-platform disk space checker without third-party for Node.js","archived":false,"fork":false,"pushed_at":"2023-12-15T00:51:10.000Z","size":807,"stargazers_count":104,"open_issues_count":5,"forks_count":25,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-04-03T20:12:50.415Z","etag":null,"topics":["disk-space","disk-usage","nodejs","npm-package"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/check-disk-space","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/Alex-D.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["Alex-D"],"patreon":"AlexandreDemode"}},"created_at":"2017-09-29T01:56:15.000Z","updated_at":"2025-03-07T02:33:36.000Z","dependencies_parsed_at":"2024-06-18T12:42:42.874Z","dependency_job_id":"f4aff29a-7dc2-4b95-ba8d-f9a67cf2cb0e","html_url":"https://github.com/Alex-D/check-disk-space","commit_stats":{"total_commits":40,"total_committers":5,"mean_commits":8.0,"dds":"0.15000000000000002","last_synced_commit":"d678b42e13facb8bf0803e5b410c78fde4f056ff"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alex-D%2Fcheck-disk-space","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alex-D%2Fcheck-disk-space/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alex-D%2Fcheck-disk-space/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alex-D%2Fcheck-disk-space/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Alex-D","download_url":"https://codeload.github.com/Alex-D/check-disk-space/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248617262,"owners_count":21134190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["disk-space","disk-usage","nodejs","npm-package"],"created_at":"2024-10-14T13:28:17.992Z","updated_at":"2025-04-12T18:44:56.968Z","avatar_url":"https://github.com/Alex-D.png","language":"TypeScript","funding_links":["https://github.com/sponsors/Alex-D","https://patreon.com/AlexandreDemode"],"categories":[],"sub_categories":[],"readme":"# Check disk space\n\n[![Continue Integration](https://img.shields.io/github/actions/workflow/status/Alex-D/check-disk-space/ci.yml?style=for-the-badge)](https://github.com/Alex-D/check-disk-space/actions/workflows/ci.yml)\n[![check-disk-space on npm](https://img.shields.io/npm/v/check-disk-space?style=for-the-badge)](https://www.npmjs.com/package/check-disk-space)\n[![License MIT](https://img.shields.io/github/license/Alex-D/check-disk-space.svg?style=for-the-badge)](LICENSE)\n\n\n## Introduction\n\nLight multi-platform disk space checker without third party for Node.js.\n\n- Works on Linux, macOS and Windows\n- Take care of mounting points on unix-like systems\n- No dependencies\n- TypeScript support\n\n\n## Install\n\n`npm install check-disk-space`\n\n\n## Usage\n\n```js\n// ES\nimport checkDiskSpace from 'check-disk-space'\n\n// CommonJS\nconst checkDiskSpace = require('check-disk-space').default\n\n// On Windows\ncheckDiskSpace('C:/blabla/bla').then((diskSpace) =\u003e {\n    console.log(diskSpace)\n    // {\n    //     diskPath: 'C:',\n    //     free: 12345678,\n    //     size: 98756432\n    // }\n    // Note: `free` and `size` are in bytes\n})\n\n// On Linux or macOS\ncheckDiskSpace('/mnt/mygames').then((diskSpace) =\u003e {\n    console.log(diskSpace)\n    // {\n    //     diskPath: '/',\n    //     free: 12345678,\n    //     size: 98756432\n    // }\n    // Note: `free` and `size` are in bytes\n})\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falex-d%2Fcheck-disk-space","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falex-d%2Fcheck-disk-space","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falex-d%2Fcheck-disk-space/lists"}