# rx-readdir

> reactive version of readdir with recursive directory scanning

Latest version **0.0.4** (published 2018-10-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install rx-readdir
pnpm add rx-readdir
yarn add rx-readdir
bun add rx-readdir
```

## 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.4 |
| Published | 2018-10-26 |
| First published | 2018-10-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Marcel van Waaijen |
| Maintainers | marcelw |

## Links

- npm: https://www.npmjs.com/package/rx-readdir
- npm.io page: https://npm.io/package/rx-readdir

## Dependencies (1)

- [rxjs](https://npm.io/package/rxjs.md) ^6.3.3

## Recent versions

- 0.0.4 (latest) — 2018-10-26
- 0.0.3 — 2018-10-17
- 0.0.2 — 2018-10-16
- 0.0.1 — 2018-10-16

## README

# rx-readdir

> reactive version of readdir with recursive directory scanning

This rxjs module returns an Observable which scans a specified folder recursively and 
optionally can exclude any sub-folders from scanning and outputs the file-/directory objects
as javascript objects.

## Usage

```js
const { readdir$ } = require ('rx-readdir')

readdir$ ('.', ['node_modules'])
.subscribe ({
    next: obj => {
        console.log (obj)
    }
})

```

outputs

```
{
    type: "File",                    // Either "Directory" or "File"
    name: "filename",                // Filename without the extension
    ext: ".txt",                     // Extension of the file, including the period
    dir: "/path",                    // Directory in which the file/directory was found
    fullPath: "/path/filename.txt",  // Full path (+ filename) of file/directory
    ctime: 2018-10-16T08:00:00.000Z, // Create timestamp
    mtime: 2018-10-16T08:00:00.000Z, // Last modified timestamp
    atime: 2018-10-16T08:00:00.000Z, // Last accessed timestamp
}
```

## Install

With [npm](https://npmjs.org/) installed, run

```
$ npm install rx-readdir
```

## Acknowledgments

rx-readdir was inspired by [dir-analyzer](https://www.npmjs.com/package/dir-analyzer) and made possible with the [rxjs, the Reactive Extensions For JavaScript](https://www.npmjs.com/package/rxjs)

## License

ISC

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