{"_id":"node-df","_rev":"139259","name":"node-df","description":"A cross-platform Node.js wrapper around the standard Unix computer program, df.","dist-tags":{"latest":"0.1.4"},"maintainers":[{"name":"adigiovanni","email":"me+npm@adrianodigiovanni.com"}],"time":{"modified":"2021-06-03T11:25:43.000Z","created":"2014-06-03T12:48:09.924Z","0.1.4":"2018-02-16T10:22:21.025Z","0.1.1":"2014-06-08T06:47:13.193Z","0.1.0":"2014-06-03T12:48:09.924Z"},"users":{"petecemi":true,"capaj":true,"red-0ne":true},"author":{"name":"Adriano Di Giovanni","email":"me@adrianodigiovanni.com","url":"http://adrianodigiovanni.com/"},"repository":{"type":"git","url":"git+https://github.com/adriano-di-giovanni/node-df.git"},"versions":{"0.1.4":{"name":"node-df","version":"0.1.4","description":"A cross-platform Node.js wrapper around the standard Unix computer program, df.","main":"lib/index.js","scripts":{"precommit":"lint-staged","test:coverage":"npm test -- --coverage","test":"jest"},"author":{"name":"Adriano Di Giovanni","email":"me@adrianodigiovanni.com","url":"http://adrianodigiovanni.com/"},"license":"MIT","dependencies":{"underscore":"^1.6.0"},"devDependencies":{"async":"^2.6.0","eslint":"^4.17.0","eslint-config-prettier":"^2.9.0","eslint-config-standard":"^11.0.0-beta.0","eslint-plugin-import":"^2.8.0","eslint-plugin-node":"^5.2.1","eslint-plugin-prettier":"^2.6.0","eslint-plugin-promise":"^3.6.0","eslint-plugin-standard":"^3.0.1","husky":"^0.14.3","jest":"^22.1.4","lint-staged":"^6.1.0","prettier":"^1.10.2"},"repository":{"type":"git","url":"git+https://github.com/adriano-di-giovanni/node-df.git"},"keywords":["node","df","disk","free","diskfree"],"bugs":{"url":"https://github.com/adriano-di-giovanni/node-df/issues"},"lint-staged":{"*.js":["eslint --fix","git add"],"*.json":["prettier --write","git add"]},"homepage":"https://github.com/adriano-di-giovanni/node-df","gitHead":"c0b554a9ed73eef970ce5d72cf3ec2d89c542a5d","_id":"node-df@0.1.4","_shasum":"79230a58a62cb0a9453f7629051e4598ce498f51","_from":".","_npmVersion":"3.10.10","_nodeVersion":"6.12.2","_npmUser":{"name":"adriano.digiovanni","email":"me@adrianodigiovanni.com"},"maintainers":[{"name":"adigiovanni","email":"me+npm@adrianodigiovanni.com"}],"dist":{"shasum":"79230a58a62cb0a9453f7629051e4598ce498f51","size":25733,"noattachment":false,"key":"/node-df/-/node-df-0.1.4.tgz","tarball":"http://registry.cnpm.dingdandao.com/node-df/download/node-df-0.1.4.tgz"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/node-df_0.1.4_1518776540906_0.7914771189768299"},"_hasShrinkwrap":false,"publish_time":1518776541025,"_cnpm_publish_time":1518776541025},"0.1.1":{"name":"node-df","version":"0.1.1","description":"A cross-platform Node.js wrapper around the standard Unix computer program, df.","main":"lib/df.js","scripts":{"test":"mocha -R spec test/"},"author":{"name":"Adriano Di Giovanni","email":"me@adrianodigiovanni.com","url":"http://adrianodigiovanni.com/"},"license":"MIT","dependencies":{"underscore":"^1.6.0"},"directories":{"test":"test"},"devDependencies":{},"repository":{"type":"git","url":"https://github.com/adriano-di-giovanni/node-df.git"},"keywords":["node","df","diskfree"],"bugs":{"url":"https://github.com/adriano-di-giovanni/node-df/issues"},"homepage":"https://github.com/adriano-di-giovanni/node-df","_id":"node-df@0.1.1","dist":{"shasum":"42ec5a15b7b491164b3de7edeef2e346a0e500ea","size":3610,"noattachment":false,"key":"/node-df/-/node-df-0.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/node-df/download/node-df-0.1.1.tgz"},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"adriano.digiovanni","email":"me@adrianodigiovanni.com"},"maintainers":[{"name":"adigiovanni","email":"me+npm@adrianodigiovanni.com"}],"publish_time":1402210033193,"_cnpm_publish_time":1402210033193,"_hasShrinkwrap":false},"0.1.0":{"name":"node-df","version":"0.1.0","description":"A cross-platform Node.js wrapper around the standard Unix computer program, [df](http://en.wikipedia.org/wiki/Df_(Unix)).","main":"lib/df.js","scripts":{"test":"mocha -R spec test/"},"author":{"name":"Adriano Di Giovanni","email":"me@adrianodigiovanni.com","url":"http://adrianodigiovanni.com/"},"license":"MIT","dependencies":{"underscore":"^1.6.0"},"directories":{"test":"test"},"devDependencies":{},"repository":{"type":"git","url":"https://github.com/adriano-di-giovanni/node-df.git"},"keywords":["node","df","diskfree"],"bugs":{"url":"https://github.com/adriano-di-giovanni/node-df/issues"},"homepage":"https://github.com/adriano-di-giovanni/node-df","_id":"node-df@0.1.0","dist":{"shasum":"11f62c7eed7f48eb8b778204b8038f48b5b02b85","size":3639,"noattachment":false,"key":"/node-df/-/node-df-0.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/node-df/download/node-df-0.1.0.tgz"},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"adriano.digiovanni","email":"me@adrianodigiovanni.com"},"maintainers":[{"name":"adigiovanni","email":"me+npm@adrianodigiovanni.com"}],"publish_time":1401799689924,"_cnpm_publish_time":1401799689924,"_hasShrinkwrap":false}},"readme":"# df\n\n[![Build Status](https://travis-ci.org/adriano-di-giovanni/node-df.svg?branch=master)](https://travis-ci.org/adriano-di-giovanni/node-df)\n\n`node-df` (abbreviation of **d**isk **f**ree) is a cross-platform Node.js wrapper around the standard Unix computer program, [df](http://en.wikipedia.org/wiki/Df_(Unix)).\n\n## Installation\n\n```\n$ npm install node-df\n```\n\n## Usage\n\n### Basic\n\n```javascript\nvar\n    df = require('node-df');\n\ndf(function (error, response) {\n    if (error) { throw error; }\n\n    console.log(JSON.stringify(response, null, 2));\n});\n```\n\nOutput from `df` looks like this:\n\n```json\n[\n  {\n    \"filesystem\": \"/dev/disk0s2\",\n    \"size\": 487546976,\n    \"used\": 164493356,\n    \"available\": 322797620,\n    \"capacity\": 0.34,\n    \"mount\": \"/\"\n  },\n  {\n    \"filesystem\": \"devfs\",\n    \"size\": 186,\n    \"used\": 186,\n    \"available\": 0,\n    \"capacity\": 1,\n    \"mount\": \"/dev\"\n  },\n  {\n    \"filesystem\": \"map -hosts\",\n    \"size\": 0,\n    \"used\": 0,\n    \"available\": 0,\n    \"capacity\": 1,\n    \"mount\": \"/net\"\n  },\n  {\n    \"filesystem\": \"map auto_home\",\n    \"size\": 0,\n    \"used\": 0,\n    \"available\": 0,\n    \"capacity\": 1,\n    \"mount\": \"/home\"\n  },\n  {\n    \"filesystem\": \"localhost:/CPYpGwk1x_UGJYGx-93flp\",\n    \"size\": 487546976,\n    \"used\": 487546976,\n    \"available\": 0,\n    \"capacity\": 1,\n    \"mount\": \"/Volumes/MobileBackups\"\n  }\n]\n```\n\nValues for `size`, `used` and `available` are expressed in `KiB` (1024 bytes).\n\nValue for `capacity` is a number between `0` and `1`. `capacity` is also known as `used%`\n\n`node-df` correctly parsed output from `df` unix program for filesystems and mount folders with whitespaces in the name.\n\n### Advanced\n\n```\nvar\n    options = {\n        file: '/',\n        prefixMultiplier: 'GB',\n        isDisplayPrefixMultiplier: true,\n        precision: 2\n    };\n\ndf(options, function (error, response) {\n    if (error) { throw error; }\n\n    console.log(JSON.stringify(response, null, 2));\n});\n```\n\nOutput from `df` now looks like this:\n\n```json\n[\n  {\n    \"filesystem\": \"/dev/disk0s2\",\n    \"size\": \"499.25GB\",\n    \"used\": \"168.44GB\",\n    \"available\": \"330.54GB\",\n    \"capacity\": 0.34,\n    \"mount\": \"/\"\n  }\n]\n```\n\n#### Options\n\n* **file**: output the amount of free space of the file system containing the specified file;\n* **prefixMultiplier**: convert `size`, `used` and `available` values from `KiB` to `MiB`, `GiB`, `PiB`, `EiB`, `ZiB`, `YiB`, `MB`, `GB`, `PB`, `EB`, `ZB`, `YB`;\n* **isDisplayPrefixMultiplier**: if `true`, values for `size`, `used` and `available` are converted to strings and `prefixMultiplier` is displayed (see example above).\n* **precision**: round `size`, `used` and `available` values to `precision` decimal digits.\n","_attachments":{},"homepage":"https://github.com/adriano-di-giovanni/node-df","bugs":{"url":"https://github.com/adriano-di-giovanni/node-df/issues"},"license":"MIT"}