field-inspector v0.9.2

node-field-inspector

Tiny field inspector for NodeJS

Install

npm install field-inspector --save

Usage

var inspector = require('field-inspector');

var ti = inspector.newInstance({
    token: {},
    game_id: {
        digit: true
    },
    user_id: {
        dight: true,
        default: 0
    },
    type: {
        values: [1, 2, 3]
    },
    description: {
        trim: true,
        empty: true,
        length_max: 128
    },
    tolower: {
        tolower: true
    },
    toupper: {
        toupper: true
    }
});

var value = {
    token: 'token',
    game_id: 1110,
    type: 1,
    description: ' abc ',
    tolower: 'Is Lower',
    toupper: 'Is Upper'
};

console.log('before', JSON.stringify(value));
var rst = ti.perform(value);
console.log('after', rst, JSON.stringify(value));

Output

before {"token":"token","game_id":1110,"type":1,"description":" abc ","tolower":"Is Lower","toupper":"Is Upper"}
after {"token":"token","game_id":1110,"type":1,"description":"abc","tolower":"is lower","toupper":"IS UPPER","user_id":0}

API

newInstance(model)

Create a field-inspector instance.

the model has two struction support
1) K/V object, V has more rules.

{remark: {empty: true}}
2) Array(object), object require a field 'name' for K, other fields was the rules.
{name: "remark", empty: true}

perform(object)

field-inspector proform the rules, it modify the parameter object.
it return a null whe no error or a *error object when detected a error.

Error object

values for error type: empty ,length, type, value, match, regexp.

{ name: 'text', type: 'regexp' }