# fs-tree-traverse

> Traverse the contents of a directory and return a list of all files contained within

Latest version **0.1.3** (published 2020-07-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install fs-tree-traverse
pnpm add fs-tree-traverse
yarn add fs-tree-traverse
bun add fs-tree-traverse
```

## 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.1.3 |
| Published | 2020-07-15 |
| First published | 2015-02-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | lennym |

## Links

- npm: https://www.npmjs.com/package/fs-tree-traverse
- Repository: https://github.com/lennym/fs-tree-traverse
- Issues: https://github.com/lennym/fs-tree-traverse/issues
- npm.io page: https://npm.io/package/fs-tree-traverse

## Dependencies (2)

- [q](https://npm.io/package/q.md) ^1.1.2
- [underscore](https://npm.io/package/underscore.md) ^1.7.0

## Recent versions

- 0.1.3 (latest) — 2020-07-15
- 0.1.1 — 2018-05-09
- 0.1.0 — 2015-02-10
- 0.0.0 — 2015-02-09

## README

# fs-tree-traverse
Traverse the contents of a directory and return a list of all files contained within

## Installation

```
npm install fs-tree-traverse
```

## Usage

Basic usage:

```javascript
var traverse = require('fs-tree-traverse');
traverse.list(__dirname, function (err, files) {
    console.log(files);
});

/* Outputs (at time of writing):

[ '/home/lmartin/dev/fs-tree-traverse/LICENSE',
  '/home/lmartin/dev/fs-tree-traverse/README.md',
  '/home/lmartin/dev/fs-tree-traverse/index.js',
  '/home/lmartin/dev/fs-tree-traverse/lib/fs-tree-traverse.js',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/graceful-fs/LICENSE',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/graceful-fs/README.md',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/graceful-fs/fs.js',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/graceful-fs/graceful-fs.js',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/graceful-fs/package.json',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/graceful-fs/polyfills.js',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/graceful-fs/test/max-open.js',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/graceful-fs/test/open.js',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/graceful-fs/test/readdir-sort.js',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/graceful-fs/test/write-then-read.js',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/q/LICENSE',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/q/README.md',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/q/package.json',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/q/q.js',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/q/queue.js',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/underscore/LICENSE',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/underscore/README.md',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/underscore/package.json',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/underscore/underscore-min.js',
  '/home/lmartin/dev/fs-tree-traverse/node_modules/underscore/underscore.js',
  '/home/lmartin/dev/fs-tree-traverse/package.json' ]

*/
```

## Options

Include hidden files/folders:

```javascript
var traverse = require('fs-tree-traverse');
traverse.list(__dirname, { hidden: true }, function (err, files) {
    console.log(files);
});
```

Output paths relative to directory:

```javascript
var traverse = require('fs-tree-traverse');
traverse.list(__dirname, { relative: true }, function (err, files) {
    console.log(files);
});
/*
=>
[ 'LICENSE',
  'README.md',
  'index.js',
  ... ]
```

## Synchronous alternative

A synchronous alternative to `list` also exists - `listSync` which uses `*Sync` fs methods.

```javascript
var traverse = require('fs-tree-traverse');
var files = traverse.listSync(__dirname);
console.log(files);

/* Outputs (at time of writing):

[ '/home/lmartin/dev/fs-tree-traverse/LICENSE',
  '/home/lmartin/dev/fs-tree-traverse/README.md',
  '/home/lmartin/dev/fs-tree-traverse/index.js',
  ... ]
*/
```

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