# find-shallow-file

> Finds a matching file as shallowly as possile in a given directory.

Latest version **1.0.0** (published 2016-11-21) · ISC license · 0 weekly downloads

## Install

```sh
npm install find-shallow-file
pnpm add find-shallow-file
yarn add find-shallow-file
bun add find-shallow-file
```

## 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 | 1.0.0 |
| Published | 2016-11-21 |
| First published | 2016-11-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | korynunn |

## Links

- npm: https://www.npmjs.com/package/find-shallow-file
- Repository: https://github.com/KoryNunn/find-shallow-file
- Homepage: https://github.com/KoryNunn/find-shallow-file#readme
- Issues: https://github.com/KoryNunn/find-shallow-file/issues
- npm.io page: https://npm.io/package/find-shallow-file

## Dependencies (1)

- [righto](https://npm.io/package/righto.md) ^2.2.1

## Recent versions

- 1.0.0 (latest) — 2016-11-21

## README

# find-shallow-file

Finds a matching file as shallowly as possile in a given directory.

# usage


Search for `index.*` in `someDirectory`, searching up to 10 directories deep.

```
findShallowestFile('someDirectory', /index\..*?/, {maxDepth: 10}, function(error, result){

    // cant error.

    // result will be either null or a path to the shallowest file that matched the regex.

});
```

See the tests for more examples.

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