Code Monkey home page Code Monkey logo

empty-spaces's Introduction

Empty-Spaces

Build Status Coverage Status npm version

js-standard-style

Check checks if a certain folder takes more space then desired

Installation

$ npm install empty-spaces

Check folder

Params:

  • 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
  console.log(result.pathSize)
  // Will print the size of the folder given to check

  console.log(result.maximumSize)
  // Will print the maximum size in MB this folder is allowed to be

  console.log(result.amountToClear)
  // 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.
}
Example:
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')
  }
})

Testing

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

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

License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.