# digest-directory

> Get hash from directory content

Latest version **0.1.0** (published 2019-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install digest-directory
pnpm add digest-directory
yarn add digest-directory
bun add digest-directory
```

## 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.0 |
| Published | 2019-03-29 |
| First published | 2018-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.3 |
| Dependencies | 2 |
| Unpacked size | 21.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Shaun Warman |
| Maintainers | shaunwarman |
| Keywords | checksum, digest, directory, hash |

## Links

- npm: https://www.npmjs.com/package/digest-directory
- Repository: https://github.com/shaunwarman/digest-directory
- Issues: https://github.com/shaunwarman/digest-directory/issues
- npm.io page: https://npm.io/package/digest-directory

## Dependencies (2)

- [file-digest](https://npm.io/package/file-digest.md) 0.0.2
- [recursive-readdir](https://npm.io/package/recursive-readdir.md) ^2.2.2

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2019-03-29
- 0.0.2 — 2018-11-01

## README

# digest-directory

[![build status](https://img.shields.io/travis/shaunwarman/digest-directory.svg)](https://travis-ci.com/shaunwarman/digest-directory)
[![code coverage](https://img.shields.io/codecov/c/github/shaunwarman/digest-directory.svg)](https://codecov.io/gh/shaunwarman/digest-directory)
[![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://lass.js.org)
[![license](https://img.shields.io/github/license/shaunwarman/digest-directory.svg)](LICENSE)
[![npm downloads](https://img.shields.io/npm/dt/digest-directory.svg)](https://npm.im/digest-directory)

> Get hash from directory content


## Table of Contents

* [Install](#install)
* [Usage](#usage)
* [Contributors](#contributors)
* [License](#license)


## Install

[npm][]:

```sh
npm install digest-directory
```

[yarn][]:

```sh
yarn add digest-directory
```


## Usage

```js
const digest = require('digest-directory');

const dirpath = '/path/to/directory';

// ... in async function
const hash = await digest(dirpath);

// ... with filter function
const hash = await digest(dirpath, fileName => fileName !== '/tmp/exclude.this');

console.log(hash);
// 62911adae73552fa3bc8691d2ca3b3e0
```


## Contributors

| Name             | Website                   |
| ---------------- | ------------------------- |
| **Shaun Warman** | <https://shaunwarman.com> |


## License

[MIT](LICENSE) © [Shaun Warman](https://shaunwarman.com)


## 

[npm]: https://www.npmjs.com/

[yarn]: https://yarnpkg.com/

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