@busy-web/utils
Version:
@busy-web util methods
165 lines • 13.3 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
/**
* @module Utils
*
*/
const logger_1 = require("./logger");
const uuid_1 = require("./uuid");
const types_1 = require("./types");
class Assert {
/**
* Asserts that a functions arguments must be of a certain length
*
* @chainable
* @public
* @static
* @method funcNumArgs
* @param args {array} This is the `arguments` keyword from the calling function
* @param argCount {number} The number of args to test for
* @param [equal=false] {boolean} false if at most this many args and true if exactly this many args.
*/
static funcNumArgs(args, argCount, equal = false) {
if (equal) {
logger_1.assert(`Function arguments must be equal to ${argCount}`, args.length === argCount);
}
else {
logger_1.assert(`Function arguments must be less then or equal to ${argCount}`, args.length <= argCount);
}
return this;
}
/**
* Assert that a value is of type string
*
* @chainable
* @static
* @public
* @method isString
* @param value {mixed} The value to test
*/
static isString(value) {
logger_1.assert(`Type error [${typeof value}] expected a string`, types_1.stringT(value));
return this;
}
/**
* Assert that a value is of type number
*
* @chainable
* @static
* @public
* @method isNumber
* @param value {mixed} The value to test
*/
static isNumber(value) {
logger_1.assert(`Type error [${typeof value}] expected a number`, types_1.numberT(value));
return this;
}
/**
* Assert that a value is of type int
*
* @chainable
* @static
* @public
* @method isInteger
* @param value {mixed} The value to test
*/
static isInteger(value) {
const stringVal = value.toString();
const numVal = parseInt(stringVal, 10);
logger_1.assert(`Type error [${typeof value}] expected an integer`, types_1.numberT(value) && numVal === value);
return this;
}
/**
* Assert that a value is of type boolean
*
* @chainable
* @static
* @public
* @method isBoolean
* @param value {mixed} The value to test
*/
static isBoolean(value) {
logger_1.assert(`Type error [${typeof value}] expected a boolean`, types_1.boolT(value));
return this;
}
/**
* Assert that a value is of type array
*
* @chainable
* @static
* @public
* @method isArray
* @param value {mixed} The value to test
*/
static isArray(value) {
logger_1.assert(`Type error [${typeof value}] expected an array`, types_1.arrayT(value));
return this;
}
/**
* Assert that a value is of type object
*
* @chainable
* @static
* @public
* @method isObject
* @param value {mixed} The value to test
*/
static isObject(value) {
logger_1.assert(`Type error [${typeof value}] expected an object`, types_1.objectT(value));
return this;
}
/**
* Assert that a value is a moment object
*
* @chainable
* @static
* @public
* @method isMoment
* @param value {mixed} The value to test
*/
static isMoment(value) {
logger_1.assert(`Type error [${value.constructor}] expected a Moment`, types_1.definedT(value) && types_1.funcT(value.unix));
return this;
}
/**
* Assert that a value is of type uuid
*
* @chainable
* @static
* @public
* @method isUUID
* @param value {mixed} The value to test
*/
static isUUID(value) {
logger_1.assert(`Type error [${value}] expected a UUID`, types_1.stringT(value) && uuid_1.isValidUUID(value));
return this;
}
/**
* Assert that a custom test
*
* @chainable
* @static
* @public
* @method test
* @param message {string} the message to display if the test fails
* @param test {boolean} A test that eveluates to true or false
*/
static test(message, test) {
logger_1.assert(message, test);
return this;
}
/**
* Throw an assertion
*
* @static
* @public
* @method throw
* @param message {string} The message to throw.
*/
static throw(message) {
logger_1.assert(message, false);
return this;
}
}
exports.default = Assert;
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"assert.js","sourceRoot":"","sources":["../src/assert.ts"],"names":[],"mappings":";;AAAA;;;GAGG;AACH,qCAAkC;AAClC,iCAAqC;AACrC,mCAAoF;AAEpF;IACC;;;;;;;;;;OAUG;IACI,MAAM,CAAC,WAAW,CAAC,IAAW,EAAE,QAAgB,EAAE,QAAiB,KAAK;QAC9E,IAAI,KAAK,EAAE;YACV,eAAM,CAAC,uCAAuC,QAAQ,EAAE,EAAE,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC;SACpF;aAAM;YACN,eAAM,CAAC,oDAAoD,QAAQ,EAAE,EAAE,IAAI,CAAC,MAAM,IAAI,QAAQ,CAAC,CAAC;SAChG;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAU;QAChC,eAAM,CAAC,eAAe,OAAO,KAAK,qBAAqB,EAAE,eAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAU;QAChC,eAAM,CAAC,eAAe,OAAO,KAAK,qBAAqB,EAAE,eAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,SAAS,CAAC,KAAU;QACjC,MAAM,SAAS,GAAW,KAAK,CAAC,QAAQ,EAAE,CAAC;QAC3C,MAAM,MAAM,GAAW,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAE/C,eAAM,CAAC,eAAe,OAAO,KAAK,uBAAuB,EAAE,eAAO,CAAC,KAAK,CAAC,IAAK,MAAM,KAAK,KAAK,CAAC,CAAC;QAChG,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,SAAS,CAAC,KAAU;QACjC,eAAM,CAAC,eAAe,OAAO,KAAK,sBAAsB,EAAE,aAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,OAAO,CAAC,KAAU;QAC/B,eAAM,CAAC,eAAe,OAAO,KAAK,qBAAqB,EAAE,cAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAU;QAChC,eAAM,CAAC,eAAe,OAAO,KAAK,sBAAsB,EAAE,eAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAU;QAChC,eAAM,CAAC,eAAe,KAAK,CAAC,WAAW,qBAAqB,EAAE,gBAAQ,CAAC,KAAK,CAAC,IAAI,aAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QACpG,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAAC,KAAU;QAC9B,eAAM,CAAC,eAAe,KAAK,mBAAmB,EAAE,eAAO,CAAC,KAAK,CAAC,IAAI,kBAAW,CAAC,KAAK,CAAC,CAAC,CAAC;QACtF,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,IAAa;QAChD,eAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,OAAe;QAClC,eAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAnKD,yBAmKC","sourcesContent":["/**\n * @module Utils\n *\n */\nimport { assert } from './logger';\nimport { isValidUUID } from './uuid';\nimport { definedT, stringT, boolT, funcT, arrayT, objectT, numberT } from './types';\n\nexport default class Assert {\n\t/**\n\t * Asserts that a functions arguments must be of a certain length\n\t *\n\t * @chainable\n\t * @public\n\t * @static\n\t * @method funcNumArgs\n\t * @param args {array} This is the `arguments` keyword from the calling function\n\t * @param argCount {number} The number of args to test for\n\t * @param [equal=false] {boolean} false if at most this many args and true if exactly this many args.\n\t */\n\tpublic static funcNumArgs(args: any[], argCount: number, equal: boolean = false): Assert {\n\t\tif (equal) {\n\t\t\tassert(`Function arguments must be equal to ${argCount}`, args.length === argCount);\n\t\t} else {\n\t\t\tassert(`Function arguments must be less then or equal to ${argCount}`, args.length <= argCount);\n\t\t}\n\t\treturn this;\n\t}\n\n\t/**\n\t * Assert that a value is of type string\n\t *\n\t * @chainable\n\t * @static\n\t * @public\n\t * @method isString\n\t * @param value {mixed} The value to test\n\t */\n\tpublic static isString(value: any): Assert {\n\t\tassert(`Type error [${typeof value}] expected a string`, stringT(value));\n\t\treturn this;\n\t}\n\n\t/**\n\t * Assert that a value is of type number\n\t *\n\t * @chainable\n\t * @static\n\t * @public\n\t * @method isNumber\n\t * @param value {mixed} The value to test\n\t */\n\tpublic static isNumber(value: any): Assert {\n\t\tassert(`Type error [${typeof value}] expected a number`, numberT(value));\n\t\treturn this;\n\t}\n\n\t/**\n\t * Assert that a value is of type int\n\t *\n\t * @chainable\n\t * @static\n\t * @public\n\t * @method isInteger\n\t * @param value {mixed} The value to test\n\t */\n\tpublic static isInteger(value: any): Assert {\n\t\tconst stringVal: string = value.toString();\n\t\tconst numVal: number = parseInt(stringVal, 10);\n\n\t\tassert(`Type error [${typeof value}] expected an integer`, numberT(value) &&  numVal === value);\n\t\treturn this;\n\t}\n\n\t/**\n\t * Assert that a value is of type boolean\n\t *\n\t * @chainable\n\t * @static\n\t * @public\n\t * @method isBoolean\n\t * @param value {mixed} The value to test\n\t */\n\tpublic static isBoolean(value: any): Assert {\n\t\tassert(`Type error [${typeof value}] expected a boolean`, boolT(value));\n\t\treturn this;\n\t}\n\n\t/**\n\t * Assert that a value is of type array\n\t *\n\t * @chainable\n\t * @static\n\t * @public\n\t * @method isArray\n\t * @param value {mixed} The value to test\n\t */\n\tpublic static isArray(value: any): Assert {\n\t\tassert(`Type error [${typeof value}] expected an array`, arrayT(value));\n\t\treturn this;\n\t}\n\n\t/**\n\t * Assert that a value is of type object\n\t *\n\t * @chainable\n\t * @static\n\t * @public\n\t * @method isObject\n\t * @param value {mixed} The value to test\n\t */\n\tpublic static isObject(value: any): Assert {\n\t\tassert(`Type error [${typeof value}] expected an object`, objectT(value));\n\t\treturn this;\n\t}\n\n\t/**\n\t * Assert that a value is a moment object\n\t *\n\t * @chainable\n\t * @static\n\t * @public\n\t * @method isMoment\n\t * @param value {mixed} The value to test\n\t */\n\tpublic static isMoment(value: any): Assert {\n\t\tassert(`Type error [${value.constructor}] expected a Moment`, definedT(value) && funcT(value.unix));\n\t\treturn this;\n\t}\n\n\t/**\n\t * Assert that a value is of type uuid\n\t *\n\t * @chainable\n\t * @static\n\t * @public\n\t * @method isUUID\n\t * @param value {mixed} The value to test\n\t */\n\tpublic static isUUID(value: any): Assert {\n\t\tassert(`Type error [${value}] expected a UUID`, stringT(value) && isValidUUID(value));\n\t\treturn this;\n\t}\n\n\t/**\n\t * Assert that a custom test\n\t *\n\t * @chainable\n\t * @static\n\t * @public\n\t * @method test\n\t * @param message {string} the message to display if the test fails\n\t * @param test {boolean} A test that eveluates to true or false\n\t */\n\tpublic static test(message: string, test: boolean): Assert {\n\t\tassert(message, test);\n\t\treturn this;\n\t}\n\n\t/**\n\t * Throw an assertion\n\t *\n\t * @static\n\t * @public\n\t * @method throw\n\t * @param message {string} The message to throw.\n\t */\n\tpublic static throw(message: string): Assert {\n\t\tassert(message, false);\n\t\treturn this;\n\t}\n}\n"]}