# dirsize

> get directory size with emitter

Latest version **2.0.0** (published 2018-06-12) · MIT license · 0 weekly downloads

## Install

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

Provides the command `dirsize`.

## 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 | 2.0.0 |
| Published | 2018-06-12 |
| First published | 2015-07-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 3 |
| Unpacked size | 7.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | coderaiser |
| Maintainers | coderaiser |
| Keywords | directory, size, emitter |

## Links

- npm: https://www.npmjs.com/package/dirsize
- Repository: https://github.com/coderaiser/node-dirsize
- Issues: https://github.com/coderaiser/node-dirsize/issues
- npm.io page: https://npm.io/package/dirsize

## Dependencies (3)

- [glob](https://npm.io/package/glob.md) ^7.1.0
- [findit](https://npm.io/package/findit.md) ~2.0.0
- [format-io](https://npm.io/package/format-io.md) ^1.0.1

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2018-06-12
- 1.0.3 — 2016-09-21
- 1.0.2 — 2016-02-12
- 1.0.1 — 2015-12-10
- 1.0.0 — 2015-07-07

## README

# DirSize [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL]

Get directory size with emitter.

## Global

`DirSize` could be installed global with

```
npm i dirsize -g
```

And used this way:

```
Usage: dirsize [path]
Options:
  -h, --help      display this help and exit
  -v, --version   output version information and exit

dirsize /tmp

```

## Local

`dirsize` could be used localy. It will emit event on every size change.

### Install

```
npm i dirsize --save
```

### How to use?

```js
const dirsize = require('dirsize');
const cwd = process.cwd();
const from = cwd + '/pipe-io';
const abortOnError = false;

const size = dirsize(from);

size.on('size', (size, currentSize, filename) => {
    process.stdout.write('\r' + size);
});

size.on('error', (error) => {
    console.error(percent, ' -> ', name, ':', error.message);
    
    if (abortOnError)
        cp.abort();
});

size.on('end', () => {});
```

## License

MIT

[NPMIMGURL]:                https://img.shields.io/npm/v/dirsize.svg?style=flat
[BuildStatusIMGURL]:        https://img.shields.io/travis/coderaiser/node-dirsize/master.svg?style=flat
[DependencyStatusIMGURL]:   https://img.shields.io/david/coderaiser/node-dirsize.svg?style=flat
[LicenseIMGURL]:            https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[NPMURL]:                   https://npmjs.org/package/dirsize "npm"
[BuildStatusURL]:           https://travis-ci.org/coderaiser/node-dirsize  "Build Status"
[DependencyStatusURL]:      https://david-dm.org/coderaiser/node-dirsize "Dependency Status"
[LicenseURL]:               https://tldrlegal.com/license/mit-license "MIT License"

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