# afu-read-dir

> 读取文件夹下全部文件夹或者文件的函数

Latest version **1.0.3** (published 2020-04-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install afu-read-dir
pnpm add afu-read-dir
yarn add afu-read-dir
bun add afu-read-dir
```

## 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 | 2020-04-25 |
| First published | 2020-04-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | hewenfutop@163.com |
| Maintainers | hewenfutop |
| Keywords | read-dir, 读取, dir-list, file-list, 文件列表, 文件夹列表, 文件和子目录 |

## Links

- npm: https://www.npmjs.com/package/afu-read-dir
- npm.io page: https://npm.io/package/afu-read-dir

## Recent versions

- 1.0.3 (latest) — 2020-04-25
- 1.0.2 — 2020-04-25
- 1.0.1 — 2020-04-25
- 1.0.0 — 2020-04-25

## README

```javascript
let readDir=require('afu-read-dir');
let fileList=readDir(dirPath,baseUrl);
 dirPath是一个目录
 baseUrl可选，如果提供，那么将生成一个相对路径
 返回结果
  {
      path:'',
      relative:'',
      type:'folder', // folder or file
      update:'',  // 文件最后一次被修改的时间戳
      children:[] // 只有folder才有children
  }
    可以创建upload.ignore.js文件，文件里面是一个函数，参数name是文件的路径
    如果返回true，那么这个文件或者文件夹将会被忽略
// 这面这个文件将忽略掉node_modules和.idea文件夹
upload.ignore.js
module.exports = name => {
  return /node_modules/.test(name) || /\.idea/.test(name)
}
```

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