# require-extras

> A simple method to require directory.

Latest version **1.0.4** (published 2019-12-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install require-extras
pnpm add require-extras
yarn add require-extras
bun add require-extras
```

## 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.4 |
| Published | 2019-12-13 |
| First published | 2019-10-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | xiaoyucoding |

## Links

- npm: https://www.npmjs.com/package/require-extras
- npm.io page: https://npm.io/package/require-extras

## Recent versions

- 1.0.4 (latest) — 2019-12-13
- 1.0.3 — 2019-10-29
- 1.0.2 — 2019-10-25
- 1.0.1 — 2019-10-25
- 1.0.0 — 2019-10-25

## README

# require-extras
将指定目录下的模块递归解析得到结果，参考自 [require-all](https://github.com/felixge/node-require-all) 库。

## 目录介绍
```
├── test 测试
├── index.js 源代码
└── README.md
```

## 如何使用
通过 npm 下载安装代码
```
$ npm install require-extras
```
最简示例
```javascript
var modules = require('require-extras')(__dirname + '/pages');
```

## 文档
### 参数
**options {Object | String}**

|属性|类型|必填|说明|
|:-|:-|:-|:-|
|dirname|String|是|指定目录|
|resolve|Function|否|对获得的模块进行处理|

**resolve(data, moduleName)**

|属性|类型|说明|
|:-|:-|:-|
|data|Object|模块的数据结果|
|moduleName|String|模块名称。即模块所在文件的相对路径，例如：`index.js`、`user/index.js`等。|

### 示例
示例一
```javascript
var requireEx = require('require-extras');
var modules = requireEx({
  dirname: __dirname + '/pages'
});
```

示例二
```javascript
var requireEx = require('require-extras');
var modules = requireEx({
  dirname: __dirname + '/pages',
  resolve: function(data, moduleName) {
    // 对数据结果进行处理
    if (data.isLaunch) {
      // 首页配置进行解析
    }
    return data;
  }
});
```

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