# spider-stream

> spider a directory and turn it into a stream

Latest version **0.2.2** (published 2014-11-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install spider-stream
pnpm add spider-stream
yarn add spider-stream
bun add spider-stream
```

## 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.2.2 |
| Published | 2014-11-10 |
| First published | 2014-03-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Calvin Metcalf |
| Maintainers | cwmma |
| Keywords | stream, dir, file |

## Links

- npm: https://www.npmjs.com/package/spider-stream
- Repository: https://github.com/calvinmetcalf/spider-stream
- Issues: https://github.com/calvinmetcalf/spider-stream/issues
- npm.io page: https://npm.io/package/spider-stream

## Dependencies (2)

- [noms](https://npm.io/package/noms.md) 0.0.0
- [minimatch](https://npm.io/package/minimatch.md) ^0.2.14

## 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

- 0.2.2 (latest) — 2014-11-10
- 0.2.1 — 2014-11-07
- 0.1.0 — 2014-04-07
- 0.0.1 — 2014-03-25

## README

spider stream
=====

```bash
npm install spider-stream
```

```js
var spiderStream = require('spiderStream');
spiderStream('path', ignore).pipe(...);
```

Give it a path and it will give you a stream of paths that are contained.

If you have a folder called foo, with a bar file and a baz folder in there with a bop file it will be called with `foo/bar` and `foo/baz/bop`.

The second argument `ignore` is an optional way to specify files to ignore, currently the default is to ignore any file or folder that:

- is named .git
- is named .DS_Store
- ends in tilda

_Note: expect the default list to increase._

If you pass `false` then nothing is ignored, passing an array replaces the default one `['.git', '.DS_Store', '*~']` filenames are matched using [minimatch][minimatch], but at the moment, only the name not the full path.

If you pass a function then it will be called on each file with 2 arguments, the filename and the full path, return a truthy value if it should be ignored.

[minimatch]: https://github.com/isaacs/minimatch

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