egg-input-regex-filter/README.zh_CN.md

filter data which from user side use regex, and returns a result data whose format is declared by coder.

# egg-input-regex-filter

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-input-regex-filter.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-input-regex-filter
[travis-image]: https://img.shields.io/travis/eggjs/egg-input-regex-filter.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-input-regex-filter
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-input-regex-filter.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-input-regex-filter?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-input-regex-filter.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-input-regex-filter
[snyk-image]: https://snyk.io/test/npm/egg-input-regex-filter/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-input-regex-filter
[download-image]: https://img.shields.io/npm/dm/egg-input-regex-filter.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-input-regex-filter

<!--
Description here.
-->

## 依赖说明

### 依赖的 egg 版本

egg-input-regex-filter 版本 | egg 1.x
--- | ---
1.x | 😁
0.x | ❌

### 依赖的插件
<!--

如果有依赖其它插件，请在这里特别说明。如

- security
- multipart

-->

## 开启插件

```js
// config/plugin.js
exports.inputRegexFilter = {
  enable: true,
  package: 'egg-input-regex-filter',
};
```

## 使用场景
```js
/**
 * this plugin is a simple class, and You can use is as a simple tool class.
 * it will return an object which has two attributes: retData, err
 * see below: 
 */
示例(sample )：
var obj = {name: 'dzhukf', age: 20 },
filter = {
  name: [
      {re: /{5,}/, errCode: -1, errMsg: '长度至少为5位'},
      {re: /^z/, errCode: -2, errMsg: '必须以z开头'},
  ],
  ... more
}

运行(and run )： Filter.doFilter(obj, filter, false )

结果(sample return ) ：
{
  retData: {name: null, age: 20 },
  err: {
      name: [{errCode: -2, errMsg: '必须以z开头' }, ... maybe more ],
      ...maybe more if you defined more than one filter 
  }
}

Filter.doFilter(obj, filter )

/**
 * use this plugin in egg.js,  this plugin map its func as app.filterReg()
 * use in controller/service , see below: 
 *
 * let filterResult = this.app.filterReg(postDataObject, filterObject )
 * 
 */
 
 
```

## 详细配置

请到 [config/config.default.js](config/config.default.js) 查看详细配置项说明。

## 单元测试

<!-- 描述如何在单元测试中使用此插件，例如 schedule 如何触发。无则省略。-->

## 提问交流

请到 [egg issues](https://github.com/eggjs/egg/issues) 异步交流。

## License

[MIT](LICENSE)