# rfc-walk

> Transverse files recursively

Latest version **3.0.4** (published 2020-05-23) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.4 |
| Published | 2020-05-23 |
| First published | 2017-02-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Rodrigo Fernandes da Costa |
| Maintainers | fcostarodrigo |
| Keywords | transverse, files, recursively, list, fs |

## Links

- npm: https://www.npmjs.com/package/rfc-walk
- Repository: https://github.com/fcostarodrigo/rfc-walk
- Homepage: https://github.com/fcostarodrigo/rfc-walk#readme
- Issues: https://github.com/fcostarodrigo/rfc-walk/issues
- npm.io page: https://npm.io/package/rfc-walk

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

- 3.0.4 (latest) — 2020-05-23
- 3.0.3 — 2018-04-29
- 3.0.2 — 2017-12-24
- 3.0.1 — 2017-12-24
- 3.0.0 — 2017-12-24
- 2.1.0 — 2017-11-04
- 2.0.0 — 2017-11-02
- 1.0.3 — 2017-03-26
- 1.0.2 — 2017-02-12
- 1.0.1 — 2017-02-05
- 1.0.0 — 2017-02-05

## README

# RFC-WALK

[![Build Status](https://travis-ci.org/fcostarodrigo/rfc-walk.svg?branch=travis)](https://travis-ci.org/fcostarodrigo/rfc-walk)
[![Maintainability](https://api.codeclimate.com/v1/badges/913749fe929e7b001441/maintainability)](https://codeclimate.com/github/fcostarodrigo/rfc-walk/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/913749fe929e7b001441/test_coverage)](https://codeclimate.com/github/fcostarodrigo/rfc-walk/test_coverage)

Simple node module to transverse files recursively.

DEPRECATED: See [@fcostarodrigo/walk](https://www.npmjs.com/package/@fcostarodrigo/walk)

## Installation

```bash
npm install rfc-walk
```

## Usage

```javascript
const walk = require("rfc-walk");

for (const file of await walk()) {
  console.log(file);
}

await walk({ onPath: console.log });

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

## Documentation

```typescript
function walk(options?: {
  root?: string;
  includeFolders?: boolean;
  onPath?: (path: string) => Promise<void> | undefined;
}): Promise<string[]>;
```

- `root`: Path to where start the search.
- `includeFolders`: If paths of folders should be returned.
- `onPath`: Called with each path found. If it returns a promise, walk will wait for it to resolve.
- Returns a promise that resolves after the search is finished and it is resolved with a list of paths if onPath is not passed.

## Development

Full tests with coverage

```bash
npm test
```

Unit tests and watch for changes

```bash
npm run unit-test
```

## License

[MIT License](http://www.opensource.org/licenses/mit-license.php)

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