# walk-dir

> "Walk" through a directory, revealing the contained folders and files in a practical way

Latest version **0.0.10** (published 2017-12-04) · MIT license · 0 weekly downloads

## Install

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

## 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.10 |
| Published | 2017-12-04 |
| First published | 2017-11-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Lars Froelich |
| Maintainers | xlfpx |
| Keywords | find, tree, file, folder, structure, directory, list |

## Links

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

## Dependencies (1)

- [fs-extra](https://npm.io/package/fs-extra.md) ^4.0.2

## 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.10 (latest) — 2017-12-04
- 0.0.8 — 2017-12-04
- 0.0.7 — 2017-12-04
- 0.0.6 — 2017-12-04
- 0.0.5 — 2017-11-30
- 0.0.4 — 2017-11-30
- 0.0.3 — 2017-11-30
- 0.0.1 — 2017-11-30

## README

# walk-Dir
NPM-Module used to "walk" through a directory, revealing the contained folders and files in a practical way.

## Why
Oftentimes when working with a node.js application, it is necessary to retrieve the structure of a certain folder in an easy-to-parse form.
This is useful e.g. when building an express.js-router or for bootstrapping child-modules automatically.

##Setup
Install walkDir via `npm install walk-dir --save`

Make sure not to confuse this module with "walkdir", this is "walk-dir"!


## Usage
1) Require walkDir using  `var walkDir = require("walkdir");`
2) Choose one of the following methods it provides:

    2.1 **List**
    
        `walkDir.list(excludedPath, includedPath, depth)`
        
    + `excludedPath`: beginning of your search-path which should **not** be included in the results.
    
    + `includedPath`: end of your search-path which **should** be included in the results.
    
    + `depth`: At what level of depth should the recursive search end?
        
        + 0: Never. End when all subdirectories have been found and listed.
        + x: End after peeking into x levels of folders, 1 being the provided path

    + **returns**: Array of Strings representing the paths to found folders and files

    2.2 **Tree**

            `walkDir.tree(excludedPath, includedPath, depth)`

    + `excludedPath`: beginning of your search-path which should **not** be included in the results.
    + `includedPath`: end of your search-path which **should** be included in the results.
    + `depth`: At what level of depth should the recursive search end?
        + 0: Never. End when all subdirectories have been found and listed.
        + x: End after peeking into x levels of folders, 1 being the provided path
    + **returns**: JS-Object-tree where folders are branches and leaves are "true". -> Full paths are built from object-keys.

3) Decide on using the *synchronous*, *promise*-based or *callback*-based version
    
    3.1 **Synchronous**
    + All methods are available as Synchronous versions by simply appending "Sync" to it
    + e.g. list**Sync**, tree**Sync**
    
    3.2 **Promises**
    + All methods return [*promises*]("https://developers.google.com/web/fundamentals/primers/promises")
    + simply use them to react to success/failure of the given method
    + e.g. `list(...).then(function(result){/** do sth with result **/ }).catch(function(err){/** react to error **/)`
    
    3.3 **Callbacks**
    + All methods accept a *callback*-function as optional last argument
    + simply pass this function using the signature `function(err, result){...}`
    + e.g. `list(..., function(err, result){/** do sth with result if !err */})`

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