# filehound

> Find files the easy way

Latest version **1.17.6** (published 2022-04-24) · MIT license · 0 weekly downloads

## Install

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

## 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 | 1.17.6 |
| Published | 2022-04-24 |
| First published | 2016-03-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 3.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 222 |
| Maintainers | nspragg |
| Keywords | file, recursive, search, filehound, file, hound, lister, find, directory, walk, walker, promise, finder, fs |

## Links

- npm: https://www.npmjs.com/package/filehound
- Repository: https://github.com/nspragg/filehound
- Issues: https://github.com/nspragg/filehound/issues
- npm.io page: https://npm.io/package/filehound

## Dependencies (6)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [moment](https://npm.io/package/moment.md) ^2.29.1
- [file-js](https://npm.io/package/file-js.md) 0.3.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.7.2
- [minimatch](https://npm.io/package/minimatch.md) ^5.0.0
- [unit-compare](https://npm.io/package/unit-compare.md) ^1.0.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.17.6 (latest) — 2022-04-24
- 2.0.0-beta.2 (beta2) — 2018-04-08
- 2.0.0-beta (beta) — 2018-04-06
- 2.0.0-alpha.4 (alpha4) — 2018-04-05
- 2.0.0-alpha.3 (alpha) — 2017-10-13
- 1.17.5 — 2021-09-21
- 1.17.4 — 2020-02-12
- 1.17.3 — 2019-07-16
- 1.17.2 — 2019-07-16
- 1.17.1 — 2019-07-09
- 1.17.0 — 2019-01-28
- 1.16.7 — 2019-01-21
- 1.16.5 — 2018-12-04
- 1.16.4 — 2018-06-06
- 1.16.3 — 2018-05-01
- … 47 more at https://npm.io/package/filehound/versions

## README

# Filehound

[![NPM downloads](https://img.shields.io/npm/dm/filehound.svg?style=flat)](https://npmjs.org/package/filehound)
![npm](https://img.shields.io/npm/v/filehound.svg)
[![Build Status](https://travis-ci.org/nspragg/filehound.svg)](https://travis-ci.org/nspragg/filehound) [![Coverage Status](https://coveralls.io/repos/github/nspragg/filehound/badge.svg?branch=master)](https://coveralls.io/github/nspragg/filehound?branch=master)
 ![license](https://img.shields.io/badge/license-MIT-blue.svg) 
![github-issues](https://img.shields.io/github/issues/nspragg/filehound.svg)
![stars](https://img.shields.io/github/stars/nspragg/filehound.svg)
![forks](https://img.shields.io/github/forks/nspragg/filehound.svg)
> Flexible and fluent interface for searching the file system

![nodei.co](https://nodei.co/npm/filehound.png?downloads=true&downloadRank=true&stars=true)


## Installation

```
npm install --save filehound
```

## Demo

<img src="https://cloud.githubusercontent.com/assets/917111/13683231/7e915c2c-e6fd-11e5-9d58-e7228cf76ccf.gif" width="600"/>

## Usage

The example below prints all of the files in a directory that have the `.json` file extension:

```js
const FileHound = require('filehound');

const files = FileHound.create()
  .paths('/some/dir')
  .ext('json')
  .find();

files.then(console.log);
```

## Documentation
For more examples and API details, see [API documentation](https://nspragg.github.io/filehound/)

## Test

```
npm test
```

To generate a test coverage report:

```
npm run coverage
```
## Contributing

* If you're unsure if a feature would make a good addition, you can always [create an issue](https://github.com/nspragg/filehound/issues/new/choose) first.
* We aim for 100% test coverage. Please write tests for any new functionality or changes.
* Any API changes should be fully documented.
* Make sure your code meets our linting standards. Run `npm run lint` to check your code.
* Maintain the existing coding style. There are some settings in `.jsbeautifyrc` to help.
* Be mindful of others when making suggestions and/or code reviewing.

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