# read-a-dir

> Read directory contents with support for custom fs implementations

Latest version **0.0.1-a** (published 2020-11-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install read-a-dir
pnpm add read-a-dir
yarn add read-a-dir
bun add read-a-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.1-a |
| Published | 2020-11-01 |
| First published | 2020-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ramón Gil Moreno |
| Maintainers | ramongilmoreno |

## Links

- npm: https://www.npmjs.com/package/read-a-dir
- Repository: https://github.com/ramongilmoreno/read-a-dir
- Issues: https://github.com/ramongilmoreno/read-a-dir/issues
- npm.io page: https://npm.io/package/read-a-dir

## Dependencies (1)

- [pino](https://npm.io/package/pino.md) ^6.4.1

## Recent versions

- 0.0.1-a (latest) — 2020-11-01

## README

# read-a-dir load a directory contents with custom `fs` implementations

Loads a directory contents and returns the list of files found on it. Allows
using custom `fs` implementations.

For example: for a directory with the following files:

    1.txt
    2/2.txt
    2/3/3.txt

It is expected that this utility returns exactly the items above; except for
the order, which may vary, as asynchronous processing of the directories is
carried out.

This utlity uses UNIX-style separators `/` for simplicty.

## Quick build guide

Build the lib with this command:

    $ npm install
    $ npm build
 
### API

#### `readdir (root, [options])`

Builds a directory representation of the files in the given root path.

This function will traverse the contents of `root`
[depth-first](https://en.wikipedia.org/wiki/Depth-first_search) manner.

By default a list of the files (not directories) paths are returned. This
behavior can be tuned with the `options` parameters.

The options object can include the following parameters:

* `fs`, the filesystem object (e.g.
  [memfs](https://github.com/streamich/memfs#readme)) used to read the files
  from. If not provided, Default Node.js 'fs' will be required instead.

* `includeHidden`, set it to `true` to process the hidden (starting with dot
  `.`) files in the processing. Ignored by default.

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