# walk-fs

> Walk the file system

Latest version **0.0.2** (published 2013-07-02) · 0 weekly downloads

## Install

```sh
npm install walk-fs
pnpm add walk-fs
yarn add walk-fs
bun add walk-fs
```

## 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.0.2 |
| Published | 2013-07-02 |
| First published | 2013-06-23 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | skoni |
| Maintainers | skoni |
| Keywords | fs, walk, file, directory |

## Links

- npm: https://www.npmjs.com/package/walk-fs
- Repository: https://github.com/skoni/walk-fs
- Issues: https://github.com/skoni/walk-fs/issues
- npm.io page: https://npm.io/package/walk-fs

## 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.0.2 (latest) — 2013-07-02
- 0.0.1 — 2013-06-23

## README

Walk a directory
----------------

### API

`walk(dir, [options], iterator, callback);`

__Parameters__:

* `dir`: absolute directory
* `options`: optional, properties: `{ recursive: [default is true] }`
* `iterator`: function(path, stats), where stats is an instance of fs.Stats
* `callback`: function(err)

Return false from the iterator to stop walking.


### Example

```javascript
var walk = require('walk-fs');

walk(__dirname, function(path, stats) {
  console.log(path, stats);

}, function(err) {
  assert(!err);
});

```

### Install

`npm install walk-fs`

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