# sugar-scan

> sugar2.0框架的文件扫描组件

Latest version **0.0.2** (published 2017-05-27) · ISC license · 0 weekly downloads

## Install

```sh
npm install sugar-scan
pnpm add sugar-scan
yarn add sugar-scan
bun add sugar-scan
```

## 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.2 |
| Published | 2017-05-27 |
| First published | 2017-05-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | ss.feng |
| Maintainers | fengshangshi |
| Keywords | 文件扫描 |

## Links

- npm: https://www.npmjs.com/package/sugar-scan
- Repository: https://github.com/fengshangshi/sugar-scan
- Homepage: https://github.com/fengshangshi/sugar-scan#readme
- Issues: https://github.com/fengshangshi/sugar-scan/issues
- npm.io page: https://npm.io/package/sugar-scan

## Dependencies (1)

- [sugar-type](https://npm.io/package/sugar-type.md) 0.0.3

## Recent versions

- 0.0.2 (latest) — 2017-05-27
- 0.0.1 — 2017-05-09

## README

# sugar-scan
## 如何使用
### 引入

```
const Scan = require('sugar-scan')
```

### 初始化

```
const scan = new Scan({
	path: './',
	ext: '*',
});
```

### 获取文件列表

直接读取scan实例的files属性，返回的是Map对象。

```
const files = scan.files;

```

### 参数

* path - 扫描的路径，必须传递，否则报错
* ext - 扫描的扩展名，默认"*"，表示所有后缀的文件，可以按数组传递

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