Merge pull request #46 from npranto/readme-api-documentation

docs(component): Adds API Description in README.md

Author: npranto

README.md

@@ -8,7 +8,7 @@ var _utils = require('./../../utils');
 
 /**
  * @desc Returns true if integer is an integer, otherwise returns false
- * @param {number} integer - an integer
+ * @param {number|string} integer - an integer
  * @return {boolean} - true or false
  *
  * @example

dist/common/isInteger/isInteger.js

@@ -7,15 +7,15 @@ Object.defineProperty(exports, "__esModule", {
 var _utils = require('./../../utils');
 
 /**
- * @desc Returns true if str an alphabetic letter, otherwise returns false
- * @param {string} str - a letter
+ * @desc Returns true if char an alphabetic letter, otherwise returns false
+ * @param {string} char - an alphabetic character
  * @return {boolean} - true or false 
  *
  * @example
  * 'a', 'V'
  */
-var isLetter = function isLetter(str) {
-  return !(0, _utils.isUndefined)(str) && !(0, _utils.isNull)(str) && (0, _utils.isString)(str) && str.length === 1 && /^[A-Za-z]$/.test(str);
+var isLetter = function isLetter(char) {
+  return !(0, _utils.isUndefined)(char) && !(0, _utils.isNull)(char) && (0, _utils.isString)(char) && char.length === 1 && /^[A-Za-z]$/.test(char);
 };
 
 exports.default = isLetter;

dist/common/isLetter/isLetter.js

@@ -12,7 +12,7 @@ var _utils = require('./../../utils');
  * @return {boolean} - true or false 
  *
  * @example
- * '-55', 6456, 0.33
+ * '-55', -6456
  */
 var isNegativeInteger = function isNegativeInteger(integer) {
   return !(0, _utils.isUndefined)(integer) && !(0, _utils.isNull)(integer) && /^(-\d+)|0$/.test(integer);

dist/common/isNegativeInteger/isNegativeInteger.js

@@ -8,7 +8,7 @@ var _utils = require('./../../utils');
 
 /**
  * @desc Returns true if password meets simple ruleset of a password (contains letters, numbers, hyphens, and underscores; length is between 6 to 18 characters), otherwise returns false
- * @param {number|string} password - a password
+ * @param {string} password - a password
  * @return {boolean} - true or false
  *
  * @example

dist/common/isPassword/isPassword.js

@@ -8,14 +8,14 @@ var _utils = require('./../../utils');
 
 /**
  * @desc Returns true if number is a valid social security number, otherwise returns false
- * @param {number|string} number - a number
+ * @param {string} ssn - a social security number
  * @return {boolean} - true or false 
  *
  * @example
  * allows following formats => '031767927', '031-76-7927', '031 76 7927'
  */
-var isSSN = function isSSN(number) {
-  return !(0, _utils.isUndefined)(number) && !(0, _utils.isNull)(number) && /^(\d{3})(-|\s)?(\d{2})(-|\s)?(\d{4})$/.test(number);
+var isSSN = function isSSN(ssn) {
+  return !(0, _utils.isUndefined)(ssn) && !(0, _utils.isNull)(ssn) && (0, _utils.isString)(ssn) && /^(\d{3})(-|\s)?(\d{2})(-|\s)?(\d{4})$/.test(ssn);
 };
 
 exports.default = isSSN;

dist/common/isSSN/isSSN.js

@@ -15,7 +15,7 @@ var _utils = require('./../../utils');
  * allows following formats => '02166', '12045-6089'
  */
 var isStandardZipCode = function isStandardZipCode(zipCode) {
-  return !(0, _utils.isUndefined)(zipCode) && !(0, _utils.isNull)(zipCode) && /^[0-9]{5}(-[0-9]{4})?$/.test(zipCode);
+  return !(0, _utils.isUndefined)(zipCode) && !(0, _utils.isNull)(zipCode) && (0, _utils.isString)(zipCode) && /^[0-9]{5}(-[0-9]{4})?$/.test(zipCode);
 };
 
 exports.default = isStandardZipCode;

dist/common/isStandardZipCode/isStandardZipCode.js

@@ -8,14 +8,14 @@ var _utils = require('./../../utils');
 
 /**
  * @desc Returns true if phoneNumber a valid US phone number, otherwise returns false
- * @param {number|string} phoneNumber - a phone number
+ * @param {string} phoneNumber - a phone number
  * @return {boolean} - true or false 
  *
  * @example
- * allows following formats => 6174330080, '(617) 433-0080', '(617)433-0080', '617.433.0080', '617-433-0080', '617 433 0080', 
+ * allows following formats => '6174330080', '(617) 433-0080', '(617)433-0080', '617.433.0080', '617-433-0080', '617 433 0080'
  */
 var isUSPhoneNumber = function isUSPhoneNumber(phoneNumber) {
-  return !(0, _utils.isUndefined)(phoneNumber) && !(0, _utils.isNull)(phoneNumber) && /^(\()?(\d{3})(\))?[\s.-]?(\d{3})[\s.-]?(\d{4})$/.test(phoneNumber);
+  return !(0, _utils.isUndefined)(phoneNumber) && !(0, _utils.isNull)(phoneNumber) && (0, _utils.isString)(phoneNumber) && /^(\()?(\d{3})(\))?[\s.-]?(\d{3})[\s.-]?(\d{4})$/.test(phoneNumber);
 };
 
 exports.default = isUSPhoneNumber;

dist/common/isUSPhoneNumber/isUSPhoneNumber.js

@@ -15,7 +15,7 @@ var _utils = require('./../../utils');
  * 'arizona', 'Oklahoma', 'RhOdE islaNd'
  */
 var isUSState = function isUSState(state) {
-  return !(0, _utils.isUndefined)(state) && !(0, _utils.isNull)(state) && /^(Alabama)|(Alaska)|(Arizona)|(Arkansas)|(California)|(Colorado)|(Connecticut)|(Delaware)|(Florida)|(Georgia)|(Hawaii)|(Idaho)|(Illinois)|(Indiana)|(Iowa)|(Kansas)|(Kentucky)|(Louisiana)|(Maine)|(Maryland)|(Massachusetts)|(Michigan)|(Minnesota)|(Mississippi)|(Missouri)|(Montana)|(Nebraska)|(Nevada)|(New Hampshire)|(New Jersey)|(New Mexico)|(New York)|(North Carolina)|(North Dakota)|(Ohio)|(Oklahoma)|(Oregon)|(Pennsylvania)|(Rhode Island)|(South Carolina)|(South Dakota)|(Tennessee)|(Texas)|(Utah)|(Vermont)|(Virginia)|(Washington)|(West Virginia)|(Wisconsin)|(Wyoming)$/i.test(state);
+  return !(0, _utils.isUndefined)(state) && !(0, _utils.isNull)(state) && (0, _utils.isString)(state) && /^(Alabama)|(Alaska)|(Arizona)|(Arkansas)|(California)|(Colorado)|(Connecticut)|(Delaware)|(Florida)|(Georgia)|(Hawaii)|(Idaho)|(Illinois)|(Indiana)|(Iowa)|(Kansas)|(Kentucky)|(Louisiana)|(Maine)|(Maryland)|(Massachusetts)|(Michigan)|(Minnesota)|(Mississippi)|(Missouri)|(Montana)|(Nebraska)|(Nevada)|(New Hampshire)|(New Jersey)|(New Mexico)|(New York)|(North Carolina)|(North Dakota)|(Ohio)|(Oklahoma)|(Oregon)|(Pennsylvania)|(Rhode Island)|(South Carolina)|(South Dakota)|(Tennessee)|(Texas)|(Utah)|(Vermont)|(Virginia)|(Washington)|(West Virginia)|(Wisconsin)|(Wyoming)$/i.test(state);
 };
 
 exports.default = isUSState;

dist/common/isUSState/isUSState.js

@@ -12,7 +12,7 @@ var _utils = require('./../../utils');
  * @return {boolean} - true or false 
  *
  * @example
- * 'A', 'B', 'Y'
+ * 'A', 'B', 'OH WOW!'
  */
 var isUpperCase = function isUpperCase(str) {
   return !(0, _utils.isUndefined)(str) && !(0, _utils.isNull)(str) && (0, _utils.isString)(str) && /^[^a-z]+$/.test(str);