weiyin / node-diskusage

Bindings around platform specific disk usage libraries.

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 two members: free and total both of which contain the amount of free space and total used space in bytes.

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.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.free);
	console.log(info.total);
});