# du

> A simple JavaScript implementation of `du -sb`

Latest version **1.0.0** (published 2019-06-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install du
pnpm add du
yarn add du
bun add du
```

Provides the command `dujs`.

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-06-23 |
| First published | 2012-12-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/du) |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 28 |
| Maintainers | rvagg, timoxley |
| Keywords | du, size |

## Links

- npm: https://www.npmjs.com/package/du
- Repository: https://github.com/rvagg/node-du
- Homepage: https://github.com/rvagg/node-du#readme
- Issues: https://github.com/rvagg/node-du/issues
- npm.io page: https://npm.io/package/du

## Dependencies (1)

- [map-async](https://npm.io/package/map-async.md) ~0.1.1

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2019-06-23
- 0.1.1 — 2019-06-23
- 0.1.0 — 2014-03-05
- 0.0.2 — 2013-06-18
- 0.0.1 — 2013-03-17
- 0.0.0-1 — 2012-12-13
- 0.0.0 — 2012-12-13

## README

# node-du

A simple JavaScript / Node.js implementation of `du -sb`. Available in npm as *du*.

[![NPM](https://nodei.co/npm/du.svg)](https://nodei.co/npm/du/)

```js
const du = require('du')

let size = await du('/home/rvagg/.npm/')
console.log(`The size of /home/rvagg/.npm/ is: ${size} bytes`)
```

Also comes with a `dujs` command if installed with `npm install du -g`, just in case `du -sb` was too many 2 too many characters for you to type.

## API: `du(directory[, options[, callback]])`

* `options`: An optional `options` object may be passed as the second argument. Currently there is only two options, a `'filter'` function that is passed a full file path and is expected to return a truthy/falsy value to indicate whether the file is included in size calculations and a `disk` option. If disk is true, then block sizing is used when calculating the size. (get's you closer to real du numbers).
* `callback`: If you supply a `callback` you'll get `(error, size)` called on it. If you don't supply a `callback`, `du()` returns a `Promise` which you can `await` on for `size`.

With a filter option:

```js
let size = await du('/tmp/foo.leveldb/', { filter: function (f) { return /\.sst$/.test(f) } })
console.log(`The size of the sst files in /tmp/foo.leveldb/ is: ${size} bytes`)
```

## Licence and Copyright

Copyright (c) 2012 [Rod Vagg](https://github.com/rvagg)

Made available under the MIT licence:

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

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