## Modules

<dl>
<dt><a href="#module_filter">filter</a></dt>
<dd></dd>
</dl>

## Classes

<dl>
<dt><a href="#Validator">Validator</a></dt>
<dd></dd>
</dl>

## Functions

<dl>
<dt><a href="#CustomValidateFunction">CustomValidateFunction(value, [req])</a> ⇒ <code>*</code></dt>
<dd></dd>
</dl>

## Typedefs

<dl>
<dt><a href="#ValidateElement">ValidateElement</a></dt>
<dd></dd>
<dt><a href="#Schema">Schema</a></dt>
<dd></dd>
</dl>

<a name="module_filter"></a>

## filter

* [filter](#module_filter)
    * [module.exports(option)](#exp_module_filter--module.exports) ⏏
        * [~ErrorResponseCallback](#module_filter--module.exports..ErrorResponseCallback) : <code>function</code>

<a name="exp_module_filter--module.exports"></a>

### module.exports(option) ⏏
**Kind**: Exported function  

| Param | Type | Description |
| --- | --- | --- |
| option | <code>Object</code> |  |
| option.basePath | <code>String</code> | The directory of validator schema files to use. |
| option.urlPrefix | <code>String</code> | The prefix string of the url path to validate. |
| [option.filenameReplaces] | <code>Object</code> | A map of data to indicate which characters to be replaced. |
| [option.filenameSuffix] | <code>String</code> | Only the files end with `option.filenameSuffix` will be processed. The default value is `.js` . |
| [option.errorResponseCallback] | <code>ErrorResponseCallback</code> |  |

<a name="module_filter--module.exports..ErrorResponseCallback"></a>

#### module.exports~ErrorResponseCallback : <code>function</code>
**Kind**: inner typedef of [<code>module.exports</code>](#exp_module_filter--module.exports)  

| Param | Type |
| --- | --- |
| req | <code>Request</code> | 
| res | <code>Response</code> | 
| next | <code>function</code> | 
| err | <code>String</code> \| <code>Object</code> \| <code>undefined</code> | 

<a name="Validator"></a>

## Validator
**Kind**: global class  

* [Validator](#Validator)
    * [new Validator()](#new_Validator_new)
    * _instance_
        * [.doValidate(params)](#Validator+doValidate) ⇒ <code>null</code> \| <code>Object</code> \| <code>String</code>
    * _static_
        * [.Validator](#Validator.Validator)
            * [new Validator(schema)](#new_Validator.Validator_new)

<a name="new_Validator_new"></a>

### new Validator()
The class of Validator

<a name="Validator+doValidate"></a>

### validator.doValidate(params) ⇒ <code>null</code> \| <code>Object</code> \| <code>String</code>
To do a validation.

**Kind**: instance method of [<code>Validator</code>](#Validator)  

| Param | Type |
| --- | --- |
| params | <code>Object</code> | 

<a name="Validator.Validator"></a>

### Validator.Validator
**Kind**: static class of [<code>Validator</code>](#Validator)  
<a name="new_Validator.Validator_new"></a>

#### new Validator(schema)
Creates an instance of Validator.


| Param | Type |
| --- | --- |
| schema | [<code>Schema</code>](#Schema) | 

<a name="CustomValidateFunction"></a>

## CustomValidateFunction(value, [req]) ⇒ <code>\*</code>
**Kind**: global function  
**Returns**: <code>\*</code> - the validate result, when none error, you can return `false` `undefined` `null` or anything can transform to false, 
when the value is not suitable, you can return a string or an object.  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>\*</code> | the value you want to validated |
| [req] | <code>http.IncomingMessage</code> | the req object of express |

<a name="ValidateElement"></a>

## ValidateElement
**Kind**: global typedef  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| required | <code>Boolean</code> \| <code>Array</code> | indicate whether the current field necessary |
| type | <code>Number</code> \| <code>JSON</code> \| <code>Date</code> \| <code>Array</code> | declare the current field's type. |
| custom | <code>FuncCustomValidateFunctiontion</code> | the custom validate function |

<a name="Schema"></a>

## Schema
**Kind**: global typedef  
**Properties**

| Name | Type |
| --- | --- |
| filedName | [<code>ValidateElement</code>](#ValidateElement) | 

**Example**  
```javascript
{
  numberFiled : {
    required:true,
    type : Number
  }
}
```
**Example**  
```javascript
{
 dateField:{
     required:[true,'the dateField can not be empty']
     type:[Date,'the dataField must be a Date']
 }
}
```