Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including empty-spaces with all npm packages installed. Try it out:

var emptySpaces = require("empty-spaces")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

empty-spaces v0.1.5

Checking how much space needs to be cleared given folder and maximum size allowed (fixed or percent out of hard-disk)


Build Status Coverage Status npm version


Check checks if a certain folder takes more space then desired


$ npm install empty-spaces

Check folder


  • Opt - An Object that contains the following properties:
  "pathToCheck": "The folder path to check",
  "maximumSize": "The maximum size in either amount in MB or percent in the form of 34%",
  "retryTime": "Time to wait before retring in case the disk is currently busy"
  • callback - a function in the form of:
function(err, result) {
  if (err) throw err
  // Will print the size of the folder given to check

  // Will print the maximum size in MB this folder is allowed to be

  // Can be 1. negative, 2. zero or 3. positive:
  // 1. Negative - The folder is smaller then the maximum allowed.
  // The abosulote value of result.amountToClear is the free size in MB.
  // 2. Zero - The folder is completly has reached the maximum allowed.
  // 3. Positive - The folder has passed the maximum size allowed
  // and result.amountToClear is the amount in MB needed to be cleared
  // from the folder to meet the maximum size limit provided.

var checkFreeSpace = require('checkFreeSize')

var options = {
  "pathToCheck": ".", // Will check the current folder
  "maximumSize": 50,
  "retryTime": 10000

checkFreeSpace(options, function (err, result) {
  if (err) throw err
  console.log('Room taken by path: ' + result.pathSize + ' MB')
  console.log('Maximum allowed size: ' + result.maximumSize + ' MB')
  if (result.amountToClear < 0) {
    console.log('Room Left: ' + (result.amountToClear * -1) + ' MB')
  } else {
    console.log('Space that needs to be clear: ' + result.amountToClear + ' MB')


In order to test you need to install mocha globaly on your machine

$ cd /"module-path"/empty-spaces
$ mocha




RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free