common-basic-validator v0.3.2

common-basic-validator

This is a unit of basic validators.

Current Status:

Installation

$ npm install common-basic-validator

Usage

import * from 'common-basic-validator';

ClassValidator.isExtend(Class, obj);

API

Validator

• isAnyValidValue

  Defined: function isAnyValidValue(anything: AnyType): Boolean

  Describe: Check the anything is any valid value.

  Examples:

  Validator.isAnyValidValue(Object);      //return true;
  Validator.isAnyValidValue(() => {});    //return true;
  Validator.isAnyValidValue({});          //return true;
  Validator.isAnyValidValue('abc');       //return true;
  Validator.isAnyValidValue(1);           //return true;
  Validator.isAnyValidValue(undefined);   //return false;
  Validator.isAnyValidValue(null);        //return false;

ClassValidator

• isClass

  Defined: function isClass(classType: Class): Boolean

  Describe: Check the class type is a Class.

  Examples:

  ClassValidator.isClass(undefined);  //return false;
  ClassValidator.isClass(null);       //return false;
  ClassValidator.isClass(1);          //return false;
  ClassValidator.isClass('abc');      //return false;
  ClassValidator.isClass({a: 1});     //return false;
  ClassValidator.isClass(Object);     //return true;
  ClassValidator.isClass(String);     //return true;

• isExtend

  Defined: function isExtend(baseClassType: Class, classType: Class): Boolean

  Describe: Check the class type is extends from base class type.

  Examples:

  class A{};
  class B extends A{};
  
  ClassValidator.isExtend(Object, String);  //return true;
  ClassValidator.isExtend(A, B);            //return true;
  ClassValidator.isExtend(Object, B);       //return true;
  ClassValidator.isExtend(B, A);            //return false;

• hasMethod

  Defined: function hasMethod(classType: Class, methodName: String): Boolean

  Describe: Check the class have this method.

  Examples:

  class Super { superMethod() {} };
  class Sub extends Super { subMethod() {} };
  
  ClassValidator.hasMethod(SubClass, 'subMethod');      //return true;
  ClassValidator.hasMethod(SubClass, 'superMethod');    //return true;
  ClassValidator.hasMethod(SubClass, 'unknownMethod');  //return false;
  ClassValidator.hasMethod(SuperClass, 'subMethod');    //return false;

FunctionValidator

• isFunction

  Defined: function isFunction(fun: Function): Boolean

  Describe: Check the fun is a Function.

  Examples:

  FunctionValidator.isFunction(undefined);  //return false;
  FunctionValidator.isFunction(null);       //return false;
  FunctionValidator.isFunction(() => {});   //return true;

NumberValidator

• isNumber

  Defined: function isNumber(num: Number): Boolean

  Describe: Check the num is a Number.

  Examples:

  NumberValidator.isNumber(undefined);      //return false;
  NumberValidator.isNumber(null);           //return false;
  NumberValidator.isNumber(1);              //return true;
  NumberValidator.isNumber(new Number(1));  //return true;

ObjectValidator

• isObj

  Defined: function isObj(obj: Object): Boolean

  Describe: Check the obj is a instance of Object;

  Examples:

  ObjectValidator.isObj(undefined);     //return false;
  ObjectValidator.isObj(1);             //return false;
  ObjectValidator.isObj('abc');         //return false;
  ObjectValidator.isObj(null);          //return true;  *NOTE* very special. just follow js default behavior.
  ObjectValidator.isObj({a: 1});        //return true;
  ObjectValidator.isObj(new Object());  //return true;

• isKindOf

  Defined: function isKindOf(classType: Class, obj: Object): Boolean

  Describe: Check the obj is belong this class type.

  Examples:

  class A{};
  class B extends A{};
  
  ObjectValidator.isKindOf(A, new A());       //return true;
  ObjectValidator.isKindOf(A, new B());       //return true;
  ObjectValidator.isKindOf(Object, new B());  //return true;
  ObjectValidator.isKindOf(B, new A());       //return false;
  ObjectValidator.isKindOf(Object, 1);        //return false;
  ObjectValidator.isKindOf(Object, 'abc');    //return false;

• isValid

  Defined: function isValid(obj: Object): Boolean

  Describe: Check the obj is a valid object.

  Examples:

  ObjectValidator.isValid(undefined);     //return false;
  ObjectValidator.isValid(null);          //return false;
  ObjectValidator.isValid({});            //return true;
  ObjectValidator.isValid({a: 1});        //return true;
  ObjectValidator.isValid(new Object());  //return true;

• hasAnyProperty

  Defined: function hasAnyProperty(obj: Object): Boolean

  Describe: Check the obj has any property.

  Examples:

  ObjectValidator.hasAnyProperty(undefined);  //return false;
  ObjectValidator.hasAnyProperty(null);       //return false;
  ObjectValidator.hasAnyProperty({});         //return false;
  ObjectValidator.hasAnyProperty({a: 1});     //return true;

• hasProperty

  Defined: function hasProperty(obj: Object, propertyName: String): Boolean

  Describe: Check the obj has property.

  Examples:

  var obj = { have: 1 };
  
  ObjectValidator.hasProperty(obj, 'have');         //return true;
  ObjectValidator.hasProperty(null, 'have');        //return false;
  ObjectValidator.hasProperty(undefined, 'have');   //return false;
  ObjectValidator.hasProperty(obj, 'doNotHave');    //return false;

StringValidator

• isString

  Defined: function isString(str: String): Boolean

  Describe: Check the str is a string.

  Examples:

  StringValidator.isString(undefined);        //return false;
  StringValidator.isString(null);             //return false;
  StringValidator.isString('abc');            //return true;
  StringValidator.isString(new String('a'));  //return true;

• isEmpty

  Defined: function isEmpty(str: String): Boolean

  Describe: Check the str is a empty string.

  Examples:

  StringValidator.isEmpty(undefined);         //return true;
  StringValidator.isEmpty(null);              //return true;
  StringValidator.isEmpty('');                //return true;
  StringValidator.isEmpty(new String());      //return true;
  StringValidator.isEmpty('abc');             //return false;
  StringValidator.isEmpty(new String('a'));   //return false;

• isNotEmpty

  Defined: function isNotEmpty(str: String): Boolean

  Describe: Check the str is not a empty string.

  Examples:

  StringValidator.isNotEmpty(undefined);         //return false;
  StringValidator.isNotEmpty(null);              //return false;
  StringValidator.isNotEmpty('');                //return false;
  StringValidator.isNotEmpty(new String());      //return false;
  StringValidator.isNotEmpty('abc');             //return true;
  StringValidator.isNotEmpty(new String('a'));   //return true;

• isBlank

  Defined: function isBlank(str: String): Boolean

  Describe: Check the str is a blank string.

  Examples:

  StringValidator.isBlank(undefined);         //return true;
  StringValidator.isBlank(null);              //return true;
  StringValidator.isBlank('');                //return true;
  StringValidator.isBlank('   ');             //return true;
  StringValidator.isBlank(new String());      //return true;
  StringValidator.isBlank(new String('  '));  //return true;
  StringValidator.isBlank('abc');             //return false;
  StringValidator.isBlank(new String('a'));   //return false;

• isNotBlank

  Defined: function isNotBlank(str: String): Boolean

  Describe: Check the str is not a blank string.

  Examples:

  StringValidator.isNotBlank(undefined);         //return false;
  StringValidator.isNotBlank(null);              //return false;
  StringValidator.isNotBlank('');                //return false;
  StringValidator.isNotBlank('   ');             //return false;
  StringValidator.isNotBlank(new String());      //return false;
  StringValidator.isNotBlank(new String('  '));  //return false;
  StringValidator.isNotBlank('abc');             //return true;
  StringValidator.isNotBlank(new String('a'));   //return true;

License

common-basic-validator is released under the MIT license.