Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cristiammercado/node-disk-info
Node module to get disk information in Windows, Linux, Mac, FreeBSD & OpenBSD (works with Electron).
https://github.com/cristiammercado/node-disk-info
disk disk-information disk-space electron linux macos module node nodejs npm windows
Last synced: about 1 month ago
JSON representation
Node module to get disk information in Windows, Linux, Mac, FreeBSD & OpenBSD (works with Electron).
- Host: GitHub
- URL: https://github.com/cristiammercado/node-disk-info
- Owner: cristiammercado
- License: mit
- Created: 2019-12-16T00:55:06.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T04:35:40.000Z (almost 2 years ago)
- Last Synced: 2024-09-28T12:23:34.468Z (about 2 months ago)
- Topics: disk, disk-information, disk-space, electron, linux, macos, module, node, nodejs, npm, windows
- Language: TypeScript
- Homepage:
- Size: 194 KB
- Stars: 60
- Watchers: 3
- Forks: 15
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Node disk info
Node module to get disk information in Windows, Linux, Mac, FreeBSD & OpenBSD. It works with Electron. The library will call system command to get drives info, parse the results and load info in array. Inspired by [diskinfo](https://github.com/BenoitGauthier/diskinfo).
[](https://travis-ci.org/cristiammercado/node-disk-info)
[](https://badge.fury.io/js/node-disk-info)
## Installation
`npm install --save node-disk-info`
## Usage
See the [example script](example/index.js) for usage. You can run it with `npm run example`.
```js
// const nodeDiskInfo = require('node-disk-info'); => Use this when install as a dependency
const nodeDiskInfo = require('./dist/index');
// async way
nodeDiskInfo.getDiskInfo()
.then(disks => {
printResults('ASYNC WAY', disks);
})
.catch(reason => {
console.error(reason);
});
// sync way
try {
const disks = nodeDiskInfo.getDiskInfoSync();
printResults('SYNC WAY', disks);
} catch (e) {
console.error(e);
}
function printResults(title, disks) {
console.log(`============ ${title} ==============\n`);
for (const disk of disks) {
console.log('Filesystem:', disk.filesystem);
console.log('Blocks:', disk.blocks);
console.log('Used:', disk.used);
console.log('Available:', disk.available);
console.log('Capacity:', disk.capacity);
console.log('Mounted:', disk.mounted, '\n');
}
}
```
Output (example run on Windows):
```
============ SYNC WAY ==============
Filesystem: Disco fijo local
Blocks: 119387713536
Used: 109906608128
Available: 9481105408
Capacity: 92%
Mounted: C:
Filesystem: Disco fijo local
Blocks: 925015994368
Used: 639386984448
Available: 285629009920
Capacity: 69%
Mounted: D:
Filesystem: Disco CD-ROM
Blocks: 0
Used: 0
Available: 0
Capacity: 0%
Mounted: E:
============ ASYNC WAY ==============
Filesystem: Disco fijo local
Blocks: 119387713536
Used: 109906608128
Available: 9481105408
Capacity: 92%
Mounted: C:
Filesystem: Disco fijo local
Blocks: 925015994368
Used: 639386984448
Available: 285629009920
Capacity: 69%
Mounted: D:
Filesystem: Disco CD-ROM
Blocks: 0
Used: 0
Available: 0
Capacity: 0%
Mounted: E:
```
## Release History & Changelog
See the [Releases](https://github.com/cristiammercado/node-disk-info/releases) page for a list of all releases, including changes.
## Help / Support
If you run into any issues, please email me at [[email protected]](mailto:[email protected]) or you can use the contact form in [my page](https://www.cristiammercado.com/en/#contact).
For bug reports, please [open an issue on GitHub](https://github.com/cristiammercado/node-disk-info/issues/new).
## Contributing
1. [Fork it](https://github.com/cristiammercado/node-disk-info).
2. Create your feature branch (`git checkout -b my-new-feature`).
3. Commit your changes (`git commit -am 'Added some feature'`).
4. Push to the branch (`git push origin my-new-feature`).
5. Create a new Pull Request.
## License
[MIT](https://github.com/cristiammercado/node-disk-info/blob/master/LICENSE)