# node-read-directory
> nodejs simple function for reading directory recursively, no matter how deep is it
Latest version **1.0.3** (published 2022-09-08) · MIT license · 0 weekly downloads
## Install
```sh
npm install node-read-directory
pnpm add node-read-directory
yarn add node-read-directory
bun add node-read-directory
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-09-08 |
| First published | 2020-03-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Nikolay Boldar |
| Maintainers | nboldar |
| Keywords | nodejs, javascript |
## Links
- npm: https://www.npmjs.com/package/node-read-directory
- Repository: https://github.com/nboldar/node-read-directory
- Homepage: https://github.com/nboldar/node-read-directory#readme
- Issues: https://github.com/nboldar/node-read-directory/issues
- npm.io page: https://npm.io/package/node-read-directory
## Recent versions
- 1.0.3 (latest) — 2022-09-08
- 1.0.2 — 2020-03-18
- 1.0.1 — 2020-03-18
- 1.0.0 — 2020-03-16
## README
# node-read-directory #
Nodejs simple lightweight function for reading directory recursively, no matter how deep is it
## Instalation ##
`npm i node-read-directory`
## Usage ##
`const readDirectory = require('node-read-directory');`
`readDirectory('./sourceDir').then( data => console.log(data)).catch( error => console.error(error));`
## How it works ##
For example source directory looks like below:
C:\USERS\USER\PROJECTS\UNTITLED\SRC
│ 1.png
│
├───emptyDir
└───thumbs
│ 50-1.png
│
└───newDir
30-2.png
So you get this:
[
{
root: 'C:\\',
dir: 'C:\\Users\\User\\Projects\\untitled\\src',
base: '1.png',
ext: '.png',
name: '1',
readDir: 'C:\\Users\\User\\Projects\\untitled\\src'
},
{
root: 'C:\\',
dir: 'C:\\Users\\User\\Projects\\untitled\\src',
base: 'emptyDir',
ext: '',
name: 'emptyDir',
readDir: 'C:\\Users\\User\\Projects\\untitled\\src'
},
{
root: 'C:\\',
dir: 'C:\\Users\\User\\Projects\\untitled\\src\\thumbs',
base: '50-1.png',
ext: '.png',
name: '50-1',
readDir: 'C:\\Users\\User\\Projects\\untitled\\src'
},
{
root: 'C:\\',
dir: 'C:\\Users\\User\\Projects\\untitled\\src\\thumbs\\newDir',
base: '30-2.png',
ext: '.png',
name: '30-2',
readDir: 'C:\\Users\\User\\Projects\\untitled\\src'
}
]
That way very usefull for coping files and directories.
---
_Source: https://npm.io/package/node-read-directory · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._