# @dropb/diskinfo

> Get disk usage info

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

## Install

```sh
npm install @dropb/diskinfo
pnpm add @dropb/diskinfo
yarn add @dropb/diskinfo
bun add @dropb/diskinfo
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2021-03-02 |
| First published | 2018-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 10.10.0 |
| Dependencies | 0 |
| Unpacked size | 9.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | kukhariev |
| Maintainers | q_h |
| Keywords | df, disk, wmic, filesystem, mount, size |

## Links

- npm: https://www.npmjs.com/package/@dropb/diskinfo
- Repository: https://github.com/kukhariev/diskinfo
- Homepage: https://github.com/kukhariev/diskinfo#readme
- Issues: https://github.com/kukhariev/diskinfo/issues
- npm.io page: https://npm.io/package/@dropb/diskinfo

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 3.0.0 (latest) — 2021-03-02
- 2.0.0 — 2020-01-04
- 1.0.6 — 2019-12-08
- 1.0.5 — 2019-06-05
- 1.0.4 — 2019-01-04
- 1.0.3 — 2018-05-19
- 1.0.2 — 2018-05-18
- 1.0.1 — 2018-05-18
- 1.0.0 — 2018-05-16
- 1.0.0-0 — 2018-05-16

## README

# diskinfo

> Disk usage info on both \*nix (via `df`) and Windows (via `WMIC`) systems

[![npm z][npm-image]][npm-url]
[![Build status][test-image]][test-url]

## Install

```sh
npm install @dropb/diskinfo
```

## Usage examples

```js
// JS example (Windows)

const { diskinfo } = require('@dropb/diskinfo');

diskinfo()
  .then(result => console.log(result))
  .catch(err => console.error(err.message));
/* OUTPUT:
[{
    fstype: '3',
    size: 185429127168,
    used: 51971362816,
    avail: 133457764352,
    pcent: '29%',
    target: 'C:'
  },
  {
    fstype: '2',
    size: 16046358528,
    used: 4434288640,
    avail: 11612069888,
    pcent: '28%',
    target: 'F:'
  },
  {
    fstype: '4',
    size: 107569381376,
    used: 106081509376,
    avail: 1487872000,
    pcent: '99%',
    target: 'V:'
  }]
*/
```

```ts
// Typescript example (Ubuntu)

import { diskinfo, DiskInfo } from '@dropb/diskinfo';

async function run() {
  const result: DiskInfo = await diskinfo('./');
  console.log(result);
}
run();
/* OUTPUT:
{ fstype: '/dev/sda1',
  size: 47242534912,
  used: 21033943040,
  avail: 23785177088,
  pcent: '47%',
  target: '/' }
*/
```

## API

```ts
/**
 * @param file - get info of the filesystem containing the specified file or directory
 * @returns promise for an object with the info for the specified file or directory
 */
function diskinfo(file: string): Promise<DiskInfo>;

/**
 * @returns promise for an array with the info for all mounted filesystem
 */
function diskinfo(): Promise<DiskInfo[]>;

/**
 * Info of the filesystem
 */
interface DiskInfo {
  /**
   * POSIX - File system type
   *
   * Win32 - Win32_LogicalDisk DriveType(as `String`!):
   * - "0": Unknown
   * - "1": No Root Directory
   * - "2": Removable Disk
   * - "3": Local Disk
   * - "4": Network Drive
   * - "5": Compact Disc
   * - "6": RAM Disk
   */
  fstype: string;
  /**
   * Total size in bytes
   */
  size: number;
  /**
   * Used size in bytes
   */
  used: number;
  /**
   * Available size in bytes
   */
  avail: number;
  /**
   * Percentage of used divided by size
   */
  pcent: string;
  /**
   * Mount point
   */
  target: string;
}
```

## References

- [df](https://www.gnu.org/software/coreutils/manual/html_node/df-invocation.html)
- [Win32_LogicalDisk WMI class](<https://msdn.microsoft.com/en-us/library/windows/desktop/aa394173(v=vs.85).aspx>)

## License

[MIT](LICENSE)

[npm-image]: https://badge.fury.io/js/%40dropb%2Fdiskinfo.svg
[npm-url]: https://www.npmjs.com/package/@dropb/diskinfo
[test-image]: https://github.com/kukhariev/diskinfo/workflows/Node%20CI/badge.svg
[test-url]: https://github.com/kukhariev/diskinfo

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