node-diskfree v0.1.0

node-diskfree

Get used, available and total disk space. This module using 'df -k' for OSX system and 'df' for *nix system.

Installation

#!javascript

[sudo] npm install node-diskfree

Usage

#!javascript

// require the module
var df = require('node-diskfree');

// retrieve disks list
df.drives(
	function (err, drivers) {
		if (err) {
			return console.log(err);
		}
		
		// retrieve space information for each drives
		df.drivesDetail(
			drives,
			function (err, data) {
				if (err) {
					return console.log(err);
				}
				
				console.log(data);
			}
		);
		
		// or retrieve space information for on drive
		df.driveDetail(
			drives[0],
			function (err, data) {
				if (err) {
					return console.log(err);
				}
				
				console.log(data);
			}
		);
	}
);

License

The MIT License (MIT)

Copyright (c) 2013 PinchProject

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Change Log

0.0.1

• first release