# empty-spaces

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

Latest version **0.1.5** (published 2015-10-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install empty-spaces
pnpm add empty-spaces
yarn add empty-spaces
bun add empty-spaces
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2015-10-15 |
| First published | 2015-06-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | thehobbit85 |
| Maintainers | thehobbit85 |
| Keywords | file system, filesystem, folder, size, file managment, folder managment |

## Links

- npm: https://www.npmjs.com/package/empty-spaces
- Repository: https://github.com/Colored-Coins/Empty-Spaces
- Homepage: https://github.com/Colored-Coins/Empty-Spaces#readme
- Issues: https://github.com/Colored-Coins/Empty-Spaces/issues
- npm.io page: https://npm.io/package/empty-spaces

## Dependencies (3)

- [async](https://npm.io/package/async.md) ^0.9.0
- [diskspace](https://npm.io/package/diskspace.md) ^0.1.7
- [get-folder-size](https://npm.io/package/get-folder-size.md) ^0.1.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.1.5 (latest) — 2015-10-15
- 0.1.4 — 2015-06-11
- 0.1.3 — 2015-06-10

## README

# Empty-Spaces
[![Build Status](https://travis-ci.org/Colored-Coins/Empty-Spaces.svg?branch=master)](https://travis-ci.org/Colored-Coins/Empty-Spaces) [![Coverage Status](https://coveralls.io/repos/Colored-Coins/Empty-Spaces/badge.svg?branch=master)](https://coveralls.io/r/Colored-Coins/Empty-Spaces?branch=master) [![npm version](https://badge.fury.io/js/empty-spaces.svg)](http://badge.fury.io/js/empty-spaces)

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

Check checks if a certain folder takes more space then desired

### Installation

```sh
$ npm install empty-spaces
```


### Check folder

Params:
  - Opt - An Object that contains the following properties:

```js
{
  "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:

  ```js
  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:

```js
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

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


License
----

MIT

[mocha]:https://www.npmjs.com/package/mocha

---
_Source: https://npm.io/package/empty-spaces · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
