67 lines
1.6 KiB
Markdown
67 lines
1.6 KiB
Markdown
[](http://badge.fury.io/js/skema)
|
|
[](https://travis-ci.org/kaelzhang/node-skema)
|
|
[](https://gemnasium.com/kaelzhang/node-skema)
|
|
|
|
# skema
|
|
|
|
Skema is common abstract node.js methods for validatiors and setters.
|
|
|
|
# Usage
|
|
```sh
|
|
npm install skema --save
|
|
```
|
|
|
|
## skema(options)
|
|
|
|
```js
|
|
var skema = require('skema');
|
|
var s = skema({
|
|
rule: {
|
|
validate: function(v){
|
|
var done = this.async();
|
|
remoteChecking(v, function(err){
|
|
done(err);
|
|
});
|
|
},
|
|
set: function(v){
|
|
return v + 1;
|
|
},
|
|
get: function(v){
|
|
return v - 1;
|
|
}
|
|
}
|
|
});
|
|
s.validate(1, function(err){
|
|
console.log(err);
|
|
});
|
|
s.set(1, function(err, v){
|
|
console.log(v); // 2
|
|
s.get(v, function(err){
|
|
console.log(v); // 1
|
|
});
|
|
});
|
|
```
|
|
|
|
## options.rule
|
|
|
|
- validate: `function(v)|RegExp|Array` Could be an validate function, or a regular expression, or an array of them.
|
|
- set: `function(v)|Array.<function(v)>`
|
|
- get: `function(v)|Array.<function(v)>`
|
|
|
|
The `this` object of each of `rule.validate`, `rule.set` and `rule.get` has a method called `async`, we can use:
|
|
|
|
```js
|
|
var done = this.async();
|
|
```
|
|
|
|
to turn the either one of the tree into an async method, as well as the familiar way of node.js.
|
|
|
|
## .validate(value, [args], callback)
|
|
|
|
- value
|
|
- args `Array=` Extra arguments that will be passed into `rule.validate` for extension.
|
|
- callback `function(err)`
|
|
|
|
## .set(value, [args], callback)
|
|
|