# @financial-times/disk-space

> Find the used and total size of the file system in kilobytes

Latest version **1.0.0** (published 2021-03-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @financial-times/disk-space
pnpm add @financial-times/disk-space
yarn add @financial-times/disk-space
bun add @financial-times/disk-space
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-03-03 |
| First published | 2021-03-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Mejdi Ourir |
| Maintainers | briggsc, the-ft, quarterto, rowanmanning, mattandrews, jakedchampion, i-like-robots, aendrew, sdbernard, bobhaslett, joannaskao, robinmarr-ft, ft-internal-products, chee, notlee, tatiana.stantonian, conor-mullen, alexwilson |

## Links

- npm: https://www.npmjs.com/package/@financial-times/disk-space
- Repository: https://github.com/Financial-Times/disk-space
- Homepage: https://github.com/Financial-Times/disk-space#readme
- Issues: https://github.com/Financial-Times/disk-space/issues
- npm.io page: https://npm.io/package/@financial-times/disk-space

## Recent versions

- 1.0.0 (latest) — 2021-03-03

## README

# @financial-times/disk-space
This module wraps the `df -BK` (or `df -bk` if on OS X) command which shows the amount of disk space available on the file system that a given file is stored on. It returns the used size and total size of the file system in kilobytes.

# Usage example

```
const diskSpace = require('@financial-times/disk-space');
diskSpace('/' , function(error, data) {
  console.log(data);  // returns { usedSize: 20, totalSize: 30 } in Kilobytes
});

```

---
_Source: https://npm.io/package/@financial-times/disk-space · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._