0.1.7 • Published 7 years ago
theeye-node-diskusage v0.1.7
node-diskusage
This module implements platform specific bindings to obtain disk usage information on Windows and nix platforms. Windows support is backed by GetDiskFreeSpaceEx and nix is implemented with statvfs.
Installation
Install with npm
:
$ npm install diskusage
Usage
The module exposes a single function, check
. It takes a path/mount point as the first argument and a callback as the second. The callback takes two arguments err
and info
. err
will be non-zero if somethine went wrong. info
contains three members: available
, free
and total
in bytes.
available
: Disk space available to the current user (i.e. Linux reserves 5% for root)free
: Disk space physically freetotal
: Total disk space (free + used)
Linux Note
statvfs
under Linux also counts for mount points mounted under the root mount. For example using the mount point /
as the first parameter would also account for /dev
, /run
, etc. in the free and total spaces.
Examples
Windows
var disk = require('diskusage');
// get disk usage. Takes path as first parameter
disk.check('c:', function(err, info) {
console.log(info.available);
console.log(info.free);
console.log(info.total);
});
Linux
var disk = require('diskusage');
// get disk usage. Takes mount point as first parameter
disk.check('/', function(err, info) {
console.log(info.available);
console.log(info.free);
console.log(info.total);
});
0.1.7
7 years ago