xmcommon - npm Package Compare versions

Comparing version 0.0.13 to 0.0.14

example/test.js

@@ -19,9 +19,23 @@ function testLog() {
 
-let a = `abc
-      bcd
-		aaaaa`;
+function testCode() {
+    let {codeUtils} = require('../index');
+    let a = [1,2,3,4];
+    let s = a.join(',');
+    let m1 = codeUtils.MD5FromString(s, 'base64');
+    let m2 = codeUtils.MD5FromArgs({encode:'base64', capital:true, split:','}, ...a);
+    console.log(m1,'\n', m2);
+}
 
-console.log(a);
+async function testHttpCall() {
+    let {CHttpCall} = require("../index");
+    let h = new CHttpCall();
+    h.init('127.0.0.1', 7369);
+    let r = await h.asyncJsonPost('/applist/appid', {});
+    console.log(JSON.stringify(r, null, 2));
+}
 
+//testHttpCall();
+testCode();
+
 //testLog();
 //testwritedir();

lib/codeutils.js

 //这里提供一些编解码的功能函数
 let crypto = require("crypto");
-
+let _ = require("lodash");
 /**
@@ -59,3 +59,46 @@ * 一组编码函数
     }
+
+    /**
+     * 根据变参，将变参数连接起来后，生成md5
+     * @param {{encode:string, capital:boolean, split:string}} paramOptions encode表示编码方式，可以是是hex或base64，默认为hex, 
+     * capital:表示是否是大小，默认是小写, split表示参数连接成符串时间隔字符串
+     * @param  {...any} args 可变参数
+     * @example
+     * let options = {
+     *  encode:'hex',  //不存在，则默认为hex
+     *  capital:false, //不存在，则默认为false, 当encode为'hex'时有效
+     *  split:''       //不存在，则默认为''
+     * };
+     * console.log(codeUtils.MD5FromArgs(options, 1,2,3,4,"test"));
+     */
+    static MD5FromArgs(paramOptions, ...args) {
+        let encode = 'hex';
+        let capital = false;
+        let split = '';
+        //分析参数
+        if(_.isObjectLike(paramOptions)) {
+            if(paramOptions.encode === 'hex' || paramOptions.encode === 'base64') {
+                encode = paramOptions.encode;
+            }
+            if(paramOptions.capital === true || paramOptions.capital === false) {
+                capital = paramOptions.capital;
+            }
+            if(encode === 'base64') {
+                capital = false;                   
+            }
+            if(_.isString(paramOptions.split)) {
+                split = paramOptions.split;
+            }
+        }
+
+        let s = args.join(split);
+        //生成md5字符串
+        let md5string = crypto.createHash('md5').update(s, 'utf8').digest(encode);
+
+        if(capital) {  //如果是要求大写
+            md5string = md5string.toUpperCase();
+        }
+        return md5string;
+    }
 }
 exports.codeUtils = codeUtils;

lib/httpcall.js

@@ -156,3 +156,3 @@ let http                   = require("http");
 
-        let req        = h.request(u, (res)=>{ requestResponse(cb, res);  });
+        let req = h.request(u, (res)=>{ requestResponse(cb, res);  });
 
@@ -219,4 +219,36 @@ req.on("error", (err)=>{
     }
+    /**
+     *同步的json post方式请求数据, 上行和响应的数据，都要都是json
+     * @async
+     * @param {String} path api路径 包括/ 如/guestlogin 
+     * @param {Object} msg 要发送的消息 
+     * @param {Object} paramHeaders 自定义的http头
+     * @param {boolean} paramHttpsFlag 是否使用 https
+     * @return {{code:number, data:object}} 响应数据
+     * @example
+     * async function test() {
+     *  let h = new CHttpCall();
+     *  h.init('127.0.0.1', 80);
+     *  let r = await h.asyncJsonPost('/api/test', {name:'test'});
+     *  console.log(r);
+     * }
+     */
+    async asyncJsonPost(path, msg, paramHeaders = null, paramHttpsFlag = false) {
+        let self = this;
+        return await utils.WaitClassFunction(self, 'jsonPost', path, msg, paramHeaders, paramHttpsFlag);        
+    }
 
     /**
+     * json get方式请求数据，要求返回的数据为JSON数据
+     * @async
+     * @param {String} path api路径 包括/ 如/guestlogin 
+     * @param {Object} msg 要发送的消息 
+     * @param {boolean} httpsFlag 是否是用https
+     * @return {{code:number, data:object}} 响应数据
+     */    
+    async asyncJsonGet(path, msg, httpsFlag = false){
+        let self = this;
+        return await utils.WaitClassFunction(self, 'jsonGet', path, msg, httpsFlag);  
+    }
+    /**
      * json post方式请求数据
@@ -223,0 +255,0 @@ * @param {(code:number, data:object)} cb 完成后的回调函数

package.json

 {
   "name": "xmcommon",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "javascript common lib for es6",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -10,4 +10,24 @@ # xmcommon
 
+# 主要模块说明
+- datetimeUtils 日期时间相关的处理工具函数
+- utils 一些常用的工具类函数
+- HttpCall 全局的CHttpCall对象
+- CHttpCall 提供api调用接口的http或https的函数调用类
+- watchRequire 监控文化变化的函数
+- SimpleCode 一种换位加编码的类
+- getLogger 取日志对象的函数
+- setGetLogger 设置getLogger函数的函数，用于替换现有的getLogger函数
+- codeUtils 一些编码相关的函数，有md5，sha254，base64等函数
+- error_common,error_utils 通用错误信息和错误相关函数
+- common_ret 通用返回的类
+- bitUtils 二进制标志的工具类
+
 # 版本变更说明
 
+## 0.0.14 
+- 2019-04-20
+- \* 优化index.d.ts部分注释, 将object变化any, 将[string]变化string[] 这样在typescript的可以正常使用
+- \+ codeUtils增加MD5FromArgs 
+- \+ CHttpCall 增加 asyncJsonPost 和 asyncJsonGet方法
+
 ## 0.0.13
@@ -14,0 +34,0 @@ - 2019-03-28

types/xmcommon/index.d.ts

@@ -78,23 +78,2 @@ // Type definitions for xmcommon 0.0
 	/**
-	 * checkObjectProperty的返回结构
-	 */
-	interface checkObjectPropertyReturn {
-		/** 返回的错误码 */
-		code:number,
-		/** 多余的属性 */
-		extra:string[],
-		/** 缺少的属性 */
-		lack:string[]
-	}
-	/**
-	 * keyValuesReturn的返回结构
-	 */
-	interface keyValuesReturn {
-		/** keys列表 */
-		keys:string[];
-		/** 值列表 */
-		values:any[]
-	}
-
-	/**
 	 * 常用的工具函数类
@@ -115,5 +94,5 @@ */
 		 * @memberOf utils
-		 * @return {[NodeJS.CallSite]} 调用堆栈列表
+		 * @return 调用堆栈列表
 		 */
-		static GetStack(): any;
+		static GetStack(): NodeJS.CallSite [];
 
@@ -124,14 +103,13 @@ /**
 		 * @memberOf utils
-		 * @param {[NodeJS.CallSite]} stack 调用堆栈列表
+		 * @param  stack 调用堆栈列表
 		 * @return {string} 返回的文件名
 		 */
-		static GetFileNameByStack(stack:any):any;
+		static GetFileNameByStack(stack: NodeJS.CallSite[]):any;
 
 		/**
 		 * 将src的属性复制到dest,只要用for in能够访问到的，都需要复制
-		 * @param {Object} dest     接收属的目标
-		 * @param {Object} src      定义属性的目标
-		 * @return {void} 无返回
+		 * @param dest     接收属的目标
+		 * @param  src      定义属性的目标
 		 */
-		static dataAssign(dest:object, src:object):void;
+		static dataAssign(dest: any, src: any):void;
 
@@ -142,6 +120,6 @@ /**
 		 * @memberOf utils
-		 * @param {[NodeJS.CallSite]} stack 调用堆栈列表
-		 * @return {number} 返回的行号
+		 * @param stack 调用堆栈列表
+		 * @return 返回的行号
 		 */
-		static GetLineNumberByStack(stack:any):number;
+		static GetLineNumberByStack(stack: NodeJS.CallSite[]):number;
 		/**
@@ -151,5 +129,5 @@ * 取当前调用堆栈信息
 		 * @memberOf utils
-		 * @return {NodeJS.CallSite} 当前的栈信息
+		 * @return 当前的栈信息
 		 */
-		static GetStackInfo() : any;
+		static GetStackInfo() : NodeJS.CallSite;
 		/**
@@ -166,7 +144,8 @@ * 检查对象的属性，是否符号要求
 		 * @memberOf utils
-		 * @param {Object} paramDestObject 被检查的属性
-		 * @param {Object} paramSimpleObject 参考属性
-		 * @return {checkObjectPropertyReturn} 返回结果
+		 * @param paramDestObject 被检查的属性
+		 * @param paramSimpleObject 参考属性
+		 * @return 返回结果
 		 */
-		static checkObjectProperty(paramDestObject:object, paramSimpleObject:object): checkObjectPropertyReturn;
+        static checkObjectProperty(paramDestObject:any, paramSimpleObject:any): 
+            { code: number, extra:string[], lack:string[] };
 
@@ -178,4 +157,4 @@
 		 * @memberOf utils
-		 * @param {any} paramV 被检查的对象
-		 * @return {boolean} 是字符串对象，则返回true,否则返回false
+		 * @param paramV 被检查的对象
+		 * @return 是字符串对象，则返回true,否则返回false
 		 */
@@ -187,4 +166,4 @@ static isString(paramV:any):boolean;
 		 * @memberOf utils
-		 * @param {any} paramV 被检查的对象
-		 * @return {boolean} 如果是，则返回true,否则返回false
+		 * @param paramV 被检查的对象
+		 * @return 如果是，则返回true,否则返回false
 		 */
@@ -196,4 +175,4 @@ static isNull(paramV:any):boolean;
 		 * @memberOf utils
-		 * @param {any} paramV 被检查的对象
-		 * @return {boolean} 如果是，则返回true,否则返回false
+		 * @param paramV 被检查的对象
+		 * @return 如果是，则返回true,否则返回false
 		 */
@@ -204,4 +183,4 @@ static isFunction(paramV:any):boolean;
 		 * @static
-		 * @param {any} paramV 被检查的对象
-		 * @return {boolean} 如果是，则返回true,否则返回false
+		 * @param paramV 被检查的对象
+		 * @return 如果是，则返回true,否则返回false
 		 */
@@ -212,4 +191,4 @@ static isInteger(paramV:any):boolean;
 		 * @static
-		 * @param {any} paramV 被检查的对象
-		 * @return {boolean} 如果是，则返回true,否则返回false
+		 * @param paramV 被检查的对象
+		 * @return 如果是，则返回true,否则返回false
 		 */
@@ -220,4 +199,4 @@ static isArray(paramV:any):boolean;
 		 * @static
-		 * @param {*} paramV 被检查的对象
-		 * @return {boolean} 如果是，则返回true,否则返回false
+		 * @param paramV 被检查的对象
+		 * @return 如果是，则返回true,否则返回false
 		 */
@@ -230,4 +209,4 @@ static isNumber(paramV:any) :boolean;
 		 * @memberOf utils
-		 * @param {any} paramV 被检查的对象
-		 * @return {boolean} 如果是，则返回true,否则返回false
+		 * @param paramV 被检查的对象
+		 * @return 如果是，则返回true,否则返回false
 		 */
@@ -239,4 +218,4 @@ static isObject(paramV:any):boolean;
 		 * @memberOf utils
-		 * @param {any} paramV 被检查的对象
-		 * @return {boolean} 如果是，则返回true,否则返回false
+		 * @param paramV 被检查的对象
+		 * @return 如果是，则返回true,否则返回false
 		 */
@@ -248,4 +227,4 @@ static isNotNull(paramV:any):boolean;
 		 * @memberOf utils
-		 * @param  {any} paramV 被检查的对象
-		 * @return {boolean} 检查结果 true表示是,false表示不是
+		 * @param paramV 被检查的对象
+		 * @return 检查结果 true表示是,false表示不是
 		 */
@@ -303,3 +282,3 @@ static isNotNullOrEmptyString(paramV:any):boolean;
 		 */
-		static WaitClassFunction(paramObject:object, paramFunction:string, ...args:any[]):any[];
+		static WaitClassFunction(paramObject:any, paramFunction:string, ...args:any[]):any[];
 		/**
@@ -321,3 +300,3 @@ *  异步调用类成员函数,注意：要求最后一个参数回调函数
 		*/
-		static WaitClassFunctionEx(paramObject:object, paramFunction:string, ...args:any[]):any[];
+		static WaitClassFunctionEx(paramObject:any, paramFunction:string, ...args:any[]):any[];
 
@@ -328,4 +307,4 @@ /**
 		 * @memberOf utils
-		 * @param {Integer} datetime_offset 要偏移的时间，单位毫秒数
-		 * @return {boolean} 返回true表示设置成功，false表示设置失败，指传入的参数不是有效的整数
+		 * @param datetime_offset 要偏移的时间，单位毫秒数
+		 * @return 返回true表示设置成功，false表示设置失败，指传入的参数不是有效的整数
 		 */
@@ -336,3 +315,3 @@ static SetDateTimeOffset(datetime_offset:number):boolean;
 		 * 使用这个方法，主要是为了方便调试一些调整日期时间的计算
-		 * @return {Number} 当前有偏移的时间
+		 * @return 当前有偏移的时间
 		 */
@@ -342,3 +321,3 @@ static GetDateTimeNow():number;
 		 * 取当前时间
-		 * @return {Number} 当前时间
+		 * @return 当前时间
 		 */
@@ -367,3 +346,3 @@ static GetCurrNow():number;
 		 * */
-		static keyValues(params:{}):{keys:[string], values:[any]};
+		static keyValues(params:any):{keys:string [], values:any []};
 
@@ -418,3 +397,3 @@ /**
 		 */
-		static options(paramArgs:[string]):{_:[any], args:{} };
+		static options(paramArgs:string[]):{_:any [], args:any };
 	}
@@ -439,4 +418,4 @@
 	 * 生成日志前缀
-	 * @param {string} paramFilename 当前的文件名
-	 * @param {...any} args 其它前缀
+	 * @param  paramFilename 当前的文件名
+	 * @param  args 其它前缀
 	 * @return {[shortpath, ...args]} 返回结果
@@ -448,4 +427,4 @@ */
 	 * 如果没有这个tag的日志，则创建一个
-	 * @param {String} tag 取指定tag的log
-	 * @return {LogConsole} 返回log
+	 * @param tag 取指定tag的log
+	 * @return 返回log
 	 */
@@ -457,4 +436,4 @@ function getLogger(tag:string):LogConsole;
 	 * 如果没有这个tag的日志，则创建一个
-	 * @param {String} tag 取指定tag的log
-	 * @return {LogConsole} 返回log
+	 * @param tag 取指定tag的log
+	 * @return 返回log
 	 */
@@ -467,4 +446,4 @@ function getLocalLogger(tag:string):LogConsole;
 	 * - 返回false表示paramGetLogger不是一个函数
-	 * @param {function} paramGetLogger 新的getLogger函数实现，替换getLogger
-	 * @return {boolean} 设置结果
+	 * @param paramGetLogger 新的getLogger函数实现，替换getLogger
+	 * @return 设置结果
 	 */
@@ -479,4 +458,4 @@ function setGetLogger(paramGetLogger:Function):boolean;
 		 * 对字符串进行Base64编码
-		 * @param {String} paramStringValue 要编码的字符串
-		 * @return {String} base64编码后的字符串
+		 * @param paramStringValue 要编码的字符串
+		 * @return base64编码后的字符串
 		 */
@@ -486,5 +465,5 @@ static StringBase64Encode(paramStringValue:string):string;
 		 * 将字符串编码后base64还原成字符串
-		 * @param {string} paramBase64Value 编码后的base64字符串
-		 * @param {string} encoding 字符串编码，主要有utf-8等
-		 * @return {String} 返回解码后的字符串
+		 * @param paramBase64Value 编码后的base64字符串
+		 * @param encoding 字符串编码，主要有utf-8等
+		 * @return 返回解码后的字符串
 		 */
@@ -494,5 +473,5 @@ static StringBase64Decode(paramBase64Value:string, encoding?:string):string;
 		 * 生成字符串的sha256编码
-		 * @param {String} paramText 要生成sha256的字符串
-		 * @param {String} paramKey sha256需要的key
-		 * @return {String} 小写十六进制的sha256字符串
+		 * @param paramText 要生成sha256的字符串
+		 * @param paramKey sha256需要的key
+		 * @return 小写十六进制的sha256字符串
 		 */
@@ -503,5 +482,5 @@ static HMacSHA256FromString(paramText:string, paramKey:string):string;
 		 * 生成字符串的Hsha256编码，注意这个不是hmac的，纯sha256编码
-		 * @param {String} paramText 要生成sha256的字符串
-		 * @param {string} paramEncode 指定输出的编码类型 hex or base64
-		 * @return {String} 小写十六进制或BASE64的sha256字符串，如果指定的编码无效，则返回null
+		 * @param paramText 要生成sha256的字符串
+		 * @param paramEncode 指定输出的编码类型 hex or base64
+		 * @return 小写十六进制或BASE64的sha256字符串，如果指定的编码无效，则返回null
 		 */
@@ -516,3 +495,18 @@ static SHA256FromString(paramText:string, paramEncode:string):string;
 		 */
-		static MD5FromString(paramString:string, paramEncode?:string):string;
+        static MD5FromString(paramString:string, paramEncode?:string):string;
+        
+        /**
+         * 根据变参，将变参数连接起来后，生成md5
+         * @param paramOptions encode表示编码方式，可以是是hex或base64，默认为hex, 
+         * capital:表示是否是大小，默认是小写, split表示参数连接成符串时间隔字符串
+         * @param  args 可变参数
+         * @example
+         * let options = {
+         *  encode:'hex',  //不存在，则默认为hex
+         *  capital:false, //不存在，则默认为false,当encode为'hex'时有效
+         *  split:''       //不存在，则默认为''
+         * };
+         * console.log(codeUtils.MD5FromArgs(options, 1,2,3,4,"test"));
+         */
+       static MD5FromArgs(paramOptions:any, ...args:any[]) : string;
 	}
@@ -526,4 +520,4 @@
 		 * 检查是否是有效的标志位
-		 * @param {Number} paramBitSite 指定的标志位
-		 * @return {boolean}
+		 * @param paramBitSite 指定的标志位
+		 * @return 检查结果
 		 */
@@ -533,5 +527,5 @@ static isValidBitSite(paramBitSite:number):boolean;
 		 * 取指定标志位的标
-		 * @param {Number} paramFlag 存放标志的31位整数
-		 * @param {Number} paramBitSite 对应的标志位，在[0,30]之间
-		 * @return {Number} 返回0或1
+		 * @param paramFlag 存放标志的31位整数
+		 * @param paramBitSite 对应的标志位，在[0,30]之间
+		 * @return 返回0或1
 		 */
@@ -541,6 +535,6 @@ static GetFlag(paramFlag:number, paramBitSite:number):number;
 		 * 设置标志位的值
-		 * @param {Number} paramFlag 存放标志的31位整数
-		 * @param {Number} paramBitSite 对应的标志位，在[0,30]之间
-		 * @param {Number} paramValue 要设置的值，只能是0或1
-		 * @return {Number} 修改标志的新值
+		 * @param paramFlag 存放标志的31位整数
+		 * @param paramBitSite 对应的标志位，在[0,30]之间
+		 * @param paramValue 要设置的值，只能是0或1
+		 * @return 修改标志的新值
 		 */
@@ -561,4 +555,4 @@ static SetFlag(paramFlag:number, paramBitSite:number, paramValue:number):number;
 		 * @static
-		 * @param {Integer} err 要判断的错误码
-		 * @return {boolean} 判断结果 true表示是OK,否则表示是false
+		 * @param err 要判断的错误码
+		 * @return 判断结果 true表示是OK,否则表示是false
 		 *
@@ -572,4 +566,4 @@ * @memberof errorUtils
 		 * @static
-		 * @param {integer} err 要判断的错误码
-		 * @return {boolean} 判断结果 err===ERR_TRUE表示是true, 否则表示是false
+		 * @param err 要判断的错误码
+		 * @return 判断结果 err===ERR_TRUE表示是true, 否则表示是false
 		 *
@@ -583,4 +577,4 @@ * @memberof errorUtils
 		 * @static
-		 * @param {integer} err 要判断的错误码
-		 * @return {boolean} 判断结果 err===ERR_FALSE表示是true, 否则表示false
+		 * @param err 要判断的错误码
+		 * @return 判断结果 err===ERR_FALSE表示是true, 否则表示false
 		 *
@@ -594,4 +588,4 @@ * @memberof errorUtils
 		 * @static
-		 * @param {Integer} err 要判断的错误码
-		 * @return {boolean } 判断结果 true表示不是OK, false表示是OK
+		 * @param err 要判断的错误码
+		 * @return 判断结果 true表示不是OK, false表示是OK
 		 *
@@ -605,4 +599,4 @@ * @memberof errorUtils
 		 * @static
-		 * @param {Integer} err 要判断的错误码
-		 * @return {boolean} 判断结果 true表示是error_code.ERR_FAIL, false表示不是error_code.ERR_FAIL
+		 * @param err 要判断的错误码
+		 * @return 判断结果 true表示是error_code.ERR_FAIL, false表示不是error_code.ERR_FAIL
 		 *
@@ -623,19 +617,19 @@ * @memberof errorUtils
 		 * 构造函数
-		 * @param {number} err=error_common.ERR_OK 错误码
-		 * @param {string} msg="" 错误信息
-		 * @param {Object} data=null 携带数据
+		 * @param err=error_common.ERR_OK 错误码
+		 * @param msg="" 错误信息
+		 * @param data=null 携带数据
 		 */
-		constructor(err?:number,msg?:string, data?:object);
+		constructor(err?:number,msg?:string, data?:any);
 		/**
 		 * 设置错误信息
-		 * @param {number} err 错误码,参考constant.js中error_common定义
-		 * @param {string} msg="" 错误信息
-		 * @param {Object} data=null 数据
-		 * @param {string} msgpre=null 错误信息前缀 相当于执于了一次addErrorPre
-		 * @return {common_ret} 返回当前this
+		 * @param err 错误码,参考constant.js中error_common定义
+		 * @param msg="" 错误信息
+		 * @param data=null 数据
+		 * @param msgpre=null 错误信息前缀 相当于执于了一次addErrorPre
+		 * @return 返回当前this
 		 */
-		setError(err:number, msg?:string, data?:object, msgpre?:string):common_ret;
+		setError(err:number, msg?:string, data?:any, msgpre?:string):common_ret;
 		/**
 		 * 取错信息
-		 * @return {string} 返回含有错误码的错误信息
+		 * @return 返回含有错误码的错误信息
 		 */
@@ -645,5 +639,4 @@ getErrorInfo():string;
 		 * 设置错误信息
-		 * @param {String} msg 设备错误信息
-		 * @param {String} msgPre=null 错误信息前缀
-		 * @return {void}
+		 * @param msg 设备错误信息
+		 * @param msgPre=null 错误信息前缀
 		 */
@@ -653,3 +646,3 @@ setErrorMsg(msg?:string, msgPre?:string):void;
 		 * 取错误信息
-		 * @return {string} 返回错误信息
+		 * @return 返回错误信息
 		 */
@@ -660,3 +653,3 @@ getErrorMsg():string;
 		 * 取错误码
-		 * @return {integer} 返回错误码
+		 * @return 返回错误码
 		 */
@@ -666,4 +659,3 @@ getErrorCode():number;
 		 *
-		 * @param {integer} err=error_code.ERR_OK 设置错误码
-		 * @return {void}
+		 * @param err=error_code.ERR_OK 设置错误码
 		 */
@@ -674,15 +666,14 @@ setErrorCode(err?:number):void;
 		 * 取携带数据
-		 * @return {Object} 携带的数据
+		 * @return 携带的数据
 		 */
-		getData():object;
+		getData(): any;
 		/**
 		 * 设置携带的数据
-		 * @param {Object} data=null 数据
-		 * @return {void}
+		 * @param  data=null 数据
 		 */
-		setData(data?:object):void;
+		setData(data?:any):void;
 
 		/**
 		 * 设置错误信息为ERR_OK;
-		 * @return {common_ret} 返回this
+		 * @return 返回this
 		 */
@@ -692,3 +683,3 @@ setErrorCodeOK():common_ret;
 		 * 设为失败
-		 * @return {common_ret} 返回this
+		 * @return 返回this
 		 */
@@ -698,36 +689,36 @@ setErrorCodeFail():common_ret;
 		 * 设为OK
-		 * @param {Object} data=null 携带的数据
-		 * @return {common_ret} 返回this
+		 * @param data=null 携带的数据
+		 * @return 返回this
 		 */
-		setOK(data?:object):common_ret;
+		setOK(data?: any): common_ret;
 		/**
 		 * 设为ERR_TRUE
-		 * @return {common_ret} 返回this
+		 * @return 返回this
 		 */
-		setTrue():common_ret;
+		setTrue(): common_ret;
 		/**
 		 * 设为ERR_FALSE
-		 * @return {common_ret} 返回this
+		 * @return 返回this
 		 */
-		setFalse():common_ret
+		setFalse(): common_ret
 		/**
 		 * 增加错误信息前缀
-		 * @param {String} msgPre 前缀
-		 * @return {common_ret} 返回this
+		 * @param msgPre 前缀
+		 * @return 返回this
 		 */
-		addErrorPre(msgPre:string):common_ret;
+		addErrorPre(msgPre: string): common_ret;
 		/**
 		 * 将错误信息复制到msgHead
 		 * 这个是专门针对协议中的msgHead
-		 * @param {Object} head 用于保存的消息头
-		 * @return {common_ret} 返回this
+		 * @param head 用于保存的消息头
+		 * @return 返回this
 		 */
-		copyTo(head:object):common_ret;
+		copyTo(head:any): common_ret;
 		/**
 		 * 将错误信息从head复制过来
 		 * 这个是专门针对协议中的msgHead
-		 * @param {Object} head 消息头
-		 * @return {common_ret} 返回this
+		 * @param head 消息头
+		 * @return 返回this
 		 */
-		setErrorFromMsghead(head:object):common_ret;
+		setErrorFromMsghead(head: any): common_ret;
 		//一组属性
@@ -858,9 +849,9 @@ readonly isOK:boolean;
 		 * @static
-		 * @param {Number} paramUTC 要转的日期对象
-		 * @param {boolean} [millsFlag=true] 是否带毫秒数
-		 * @param {String} [daysplit='-'] 日期分隔符
-		 * @param {String} [timesplit=':'] 时间分隔符
-		 * @param {String} [millissplit='.'] 毫秒分隔符
-		 * @param {String} [datetimesplit=' '] 日期和时间的分隔符
-		 * @return {String} 转换后的字符串, 如果是无效时间戳，则返回null
+		 * @param paramUTC 要转的日期对象
+		 * @param millsFlag 是否带毫秒数
+		 * @param daysplit 日期分隔符
+		 * @param timesplit 时间分隔符
+		 * @param millissplit 毫秒分隔符
+		 * @param datetimesplit 日期和时间的分隔符
+		 * @return 转换后的字符串, 如果是无效时间戳，则返回null
 		 *
@@ -949,5 +940,4 @@ * @memberOf datetimeUtils
 		 * 初始化函数
-		 * @param {string} paramHost host的地址
-		 * @param {number} paramPort host的端口
-		 * @return {void}
+		 * @param paramHost host的地址
+		 * @param paramPort host的端口
 		 */
@@ -957,30 +947,57 @@ init(paramHost:string, paramPort:number):void
 		 * json get方式请求数据
-		 * @param {(code:number, data:object)} cb 完成后的回调函数
-		 * @param {String} path api路径 包括/ 如/guestlogin
-		 * @param {Object} msg 要发送的消息
-		 * @param {boolean} httpsFlag 是否是用https
-		 * @return {number} 错误码
+		 * @param cb 完成后的回调函数
+		 * @param path api路径 包括/ 如/guestlogin
+		 * @param msg 要发送的消息
+		 * @param httpsFlag 是否是用https
+		 * @return 错误码
 		 */
-		jsonGet(cb:(code:number,data:object)=>void, path:string, msg:string, httpsFlag?:boolean):number;
+		jsonGet(cb:(code:number,data:any)=>void, path:string, msg:string, httpsFlag?:boolean):number;
 
-	/**
+	    /**
 		 * json post方式请求数据,传入的消息是字符串
-		 * @param {(code:number, data:object)} cb 完成后的回调函数
-		 * @param {String} path api路径 包括/ 如/guestlogin
-		 * @param {String} msg 要发送的消息
-		 * @param {Object} paramHeaders 自定义的http头
-		 * @param {boolean} paramHttpsFlag 是否使用 https
-		 * @return {number} 错误码
+		 * @param cb 完成后的回调函数
+		 * @param path api路径 包括/ 如/guestlogin
+		 * @param msg 要发送的消息
+		 * @param paramHeaders 自定义的http头
+		 * @param paramHttpsFlag 是否使用 https
+		 * @return 错误码
 		 */
-		jsonPostStringBody(cb:(code:number,data:object)=>void, path:string, msg:string, paramHeaders:object, paramHttpsFlag?:boolean):number;
+		jsonPostStringBody(cb:(code:number,data:any)=>void, path:string, msg:string, paramHeaders:any, paramHttpsFlag?:boolean):number;
 		/**
 		 * json post方式请求数据
-		 * @param {(code:number, data:object)} cb 完成后的回调函数
-		 * @param {String} path api路径 包括/ 如/guestlogin
-		 * @param {Object} msg 要发送的消息
-		 * @param {Object} paramHeaders 自定义的http头
-		 * @param {boolean} paramHttpsFlag 是否使用 https
-		 * @return {number} 错误码
+		 * @param cb 完成后的回调函数
+		 * @param path api路径 包括/ 如/guestlogin
+		 * @param msg 要发送的消息
+		 * @param paramHeaders 自定义的http头
+		 * @param paramHttpsFlag 是否使用 https
+		 * @return 错误码
 		 */
-		jsonPost(cb:(code:number,data:object)=>void, path:string, msg:object, paramHeaders:object, paramHttpsFlag?:boolean):number;
+        jsonPost(cb:(code:number,data:any)=>void, path:string, msg:any, paramHeaders:any, paramHttpsFlag?:boolean):number;
+        
+        /**
+         *同步的json post方式请求数据
+        * @async
+        * @param path api路径 包括/ 如/guestlogin 
+        * @param msg 要发送的消息 
+        * @param paramHeaders 自定义的http头
+        * @param paramHttpsFlag 是否使用 https
+        * @return 响应的错误和数据
+        * @example
+        * async function test() {
+        *  let h = new CHttpCall();
+        *  h.init('127.0.0.1', 80);
+        *  let r = await h.asyncJsonPost('/api/test', {name:'test'});
+        *  console.log(r);
+        * }
+        */
+        asyncJsonPost(path:string, msg:any, paramHeaders?:any, paramHttpsFlag?:boolean): {code:number, data:any};  
+        /**
+         * json get方式请求数据，要求返回的数据为JSON数据
+         * @async
+         * @param path api路径 包括/ 如/guestlogin 
+         * @param msg 要发送的消息 
+         * @param  httpsFlag 是否是用https
+         * @return {{code:number, data:object}} 响应数据
+         */    
+        asyncJsonGet(path:string, msg: any, httpsFlag?:boolean) :{code:number, data:any};          
 	}
@@ -1002,5 +1019,5 @@ /**
 		 * 数据编码
-		 * @param {number} paramSeed 编码种子
-		 * @param {Buffer} paramData 要编码的数据
-		 * @return {{code:number, seed:number, data:Buffer}} 返回处理结果，code==0表示成功，其它值表示失败， seed表示编码的种子， data表示编码后的数据
+		 * @param paramSeed 编码种子
+		 * @param paramData 要编码的数据
+		 * @return 返回处理结果，code==0表示成功，其它值表示失败， seed表示编码的种子， data表示编码后的数据
 		 */
@@ -1010,5 +1027,5 @@ Encode(paramSeed:number, paramData:Buffer):{code:number,seed:number, data:Buffer};
 		 * 数据解码
-		 * @param {number} paramSeed 初始种子
-		 * @param {Buffer} paramData 编码后的数据
-		 * @return {{code:number, seed:number, data:Buffer}} 返回处理结果，code==0表示成功，其它值表示失败， seed表示解码的种子， data表示解码后的数据
+		 * @param paramSeed 初始种子
+		 * @param paramData 编码后的数据
+		 * @return 返回处理结果，code==0表示成功，其它值表示失败， seed表示解码的种子， data表示解码后的数据
 		 */
@@ -1018,5 +1035,5 @@ Decode(paramSeed:number, paramData:Buffer):{code:number, seed:number, data:Buffer};
 		 * 生数据编码包
-		 * @param {number} paramSeed 初始种子
-		 * @param {Buffer} paramData 要编码的数据
-		 * @return {{code:number, seed:number, data:Buffer}} 返回处理结果，code==0表示成功，其它值表示失败， seed表示编码的种子， data表示编码后的数据
+		 * @param paramSeed 初始种子
+		 * @param paramData 要编码的数据
+		 * @return 返回处理结果，code==0表示成功，其它值表示失败， seed表示编码的种子， data表示编码后的数据
 		 */
@@ -1026,4 +1043,4 @@ EncodePackage(paramSeed:number, paramData:Buffer):{code:number, seed:number, data:Buffer};
 		 * 数据解码包
-		 * @param {Buffer} 经EncodePackage编码的数据
-		 * @return {{code:integer, seed:integer, data:Buffer}} 返回处理结果，code==0表示成功，其它值表示失败， seed表示解码的种子， data表示解码后的数据
+		 * @param 经EncodePackage编码的数据
+		 * @return 返回处理结果，code==0表示成功，其它值表示失败， seed表示解码的种子， data表示解码后的数据
 		 */
@@ -1035,7 +1052,6 @@ DecodePackage(paramData:Buffer):{code:number, seed:number, data:Buffer};
 	 * 这个主要是用于动态加载
-	 * @param {Function} paramCallback 文件有变化，加载后的回调函数
-	 * @param {string} paramPath 环境所在的路径
-	 * @param {string} paramFile 要watch的文件名
-	 * @param {boolean} paramChangeCallback 有变化才回调
-	 * @return {void}
+	 * @param paramCallback 文件有变化，加载后的回调函数
+	 * @param paramPath 环境所在的路径
+	 * @param paramFile 要watch的文件名
+	 * @param paramChangeCallback 有变化才回调
 	 */
@@ -1042,0 +1058,0 @@ function watchRequire(paramCallback:(data:any)=>void, paramPath:string, paramFile:string, paramChangeCallback?:boolean):void;

types/xmcommon/tsconfig.json

@@ -14,3 +14,3 @@ {
         ],
-        "types": [],
+        "types": ["node"],
         "noEmit": true,
@@ -17,0 +17,0 @@ "forceConsistentCasingInFileNames": true

No alert changes

Improved metrics

Total package byte prevSize

274441

increased by170.45%

Number of package files

27

increased by17.39%

Lines of code

3161

increased by3.54%

Number of lines in readme file

104

increased by23.81%

No dependency changes