xmcommon - npm Package Compare versions

Comparing version 0.1.7 to 0.1.8

lib/common_ret.js

@@ -175,5 +175,16 @@ let {error_common, error_utils} = require("./common_error");
     get isFalse() { return error_utils.isFalse(this.err); }
-
+    /**
+     * 重载toJSON方法
+     * @return {{isOK: boolean, err: number, msg: string, data: object}} 返回非类的对象
+     */
+    toJSON() {
+        return {
+            isOK: this.isOK,
+            err : this.err,
+            msg : this.msg,
+            data: this.data
+        }
+    }
 }
 
 exports.common_ret = common_ret;

lib/httpcall.js

@@ -0,1 +1,7 @@
+/**
+ * 这个基于标准库的httpcall由于功能比较早期，现在也主要使用got代替了，将会在未来的版本中，逐步删除
+ * @deprecated
+ * @date 2021-04-28
+ */
+
 let http                   = require("http");
@@ -10,2 +16,3 @@ let https                  = require("https");
  * HttpCall的错误码定义
+ * @deprecated
  */
@@ -21,3 +28,3 @@ const HttpCallError = {
     PATH_NOT_STRING      : -7,   //参数path不是字符串
-    MSG_NOT_OBJECT       : -8,   //要发送的消息，不是object   
+    MSG_NOT_OBJECT       : -8,   //要发送的消息，不是object
     MSG_NOT_STRING       : -9,   //要发送的消息，不是字符串
@@ -36,2 +43,3 @@
  * @return {number} 检查结果HttpCallError 中错误的定义
+ * @deprecated
  * @see HttpCallError
@@ -58,2 +66,3 @@ */
  * @param {object} res 响应对象
+ * @deprecated
  * @return {void}
@@ -111,2 +120,3 @@ */
  * 对于POST则请求的数据，也是JSON数据(这里会把Object转换成JSON字符串)
+ * @deprecated
  */
@@ -133,8 +143,8 @@ class CHttpCall {
      * json get方式请求数据
-     * @param {(code:number, data:object)} cb 完成后的回调函数 
-     * @param {String} path api路径 包括/ 如/guestlogin 
-     * @param {Object} msg 要发送的消息 
+     * @param {(code:number, data:object)} cb 完成后的回调函数
+     * @param {String} path api路径 包括/ 如/guestlogin
+     * @param {Object} msg 要发送的消息
      * @param {boolean} httpsFlag 是否是用https
      * @return {number} 错误码
-     */    
+     */
     jsonGet(cb, path, msg, httpsFlag = false){
@@ -146,3 +156,3 @@ //检查传入参数是否合法
         }
-        
+
         //使用URLSearchParams是解决名称或值中特殊字符的问题
@@ -178,5 +188,5 @@ let p = new URLSearchParams();
      * json post方式请求数据,传入的消息是字符串
-     * @param {(code:number, data:object)} cb 完成后的回调函数 
-     * @param {String} path api路径 包括/ 如/guestlogin 
-     * @param {String} msg 要发送的消息 
+     * @param {(code:number, data:object)} cb 完成后的回调函数
+     * @param {String} path api路径 包括/ 如/guestlogin
+     * @param {String} msg 要发送的消息
      * @param {Object} paramHeaders 自定义的http头
@@ -196,5 +206,5 @@ * @param {boolean} paramHttpsFlag 是否使用 https
         }
-        
+
         let content = msg;
-        
+
         let headers = {};
@@ -207,3 +217,3 @@ if(utils.isNotNull(paramHeaders)) {
 
-        let options = { 
+        let options = {
             hostname: this.m_host,
@@ -213,4 +223,4 @@ port    : this.m_port,
             method  : 'POST',
-            headers 
-        }; 
+            headers
+        };
         let h = paramHttpsFlag ? https : http;
@@ -232,4 +242,4 @@ log.info("%o",options);
      * @async
-     * @param {String} path api路径 包括/ 如/guestlogin 
-     * @param {Object} msg 要发送的消息 
+     * @param {String} path api路径 包括/ 如/guestlogin
+     * @param {Object} msg 要发送的消息
      * @param {Object} paramHeaders 自定义的http头
@@ -248,3 +258,3 @@ * @param {boolean} paramHttpsFlag 是否使用 https
         let self = this;
-        return await utils.WaitClassFunction(self, 'jsonPost', path, msg, paramHeaders, paramHttpsFlag);        
+        return await utils.WaitClassFunction(self, 'jsonPost', path, msg, paramHeaders, paramHttpsFlag);
     }
@@ -255,16 +265,16 @@
      * @async
-     * @param {String} path api路径 包括/ 如/guestlogin 
-     * @param {Object} msg 要发送的消息 
+     * @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);  
+        return await utils.WaitClassFunction(self, 'jsonGet', path, msg, httpsFlag);
     }
     /**
      * json post方式请求数据
-     * @param {(code:number, data:object)} cb 完成后的回调函数 
-     * @param {String} path api路径 包括/ 如/guestlogin 
-     * @param {Object} msg 要发送的消息 
+     * @param {(code:number, data:object)} cb 完成后的回调函数
+     * @param {String} path api路径 包括/ 如/guestlogin
+     * @param {Object} msg 要发送的消息
      * @param {Object} paramHeaders 自定义的http头
@@ -280,5 +290,5 @@ * @param {boolean} paramHttpsFlag 是否使用 https
         }
-        
+
         let content = JSON.stringify(msg);
-        
+
         let headers = {};
@@ -291,3 +301,3 @@ if(utils.isNotNull(paramHeaders)) {
 
-        let options = { 
+        let options = {
             hostname: this.m_host,
@@ -297,4 +307,4 @@ port    : this.m_port,
             method  : 'POST',
-            headers 
-        }; 
+            headers
+        };
         let h = paramHttpsFlag ? https : http;
@@ -314,6 +324,8 @@ log.info("%o",options);
 }
-
+/**
+ * @deprecated
+ */
 let HttpCall              = new CHttpCall();
     exports.HttpCall      = HttpCall;
     exports.CHttpCall     = CHttpCall;
-    exports.HttpCallError = HttpCallError;
+    exports.HttpCallError = HttpCallError;

lib/index.js

@@ -29,2 +29,2 @@ const { datetimeUtils }                      = require('./datetimeUtils');
     error_utils
- };
+};

package.json

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

README.md

@@ -20,4 +20,4 @@ # xmcommon
 - utils 一些常用的工具类函数
-- HttpCall 全局的CHttpCall对象
-- CHttpCall 提供api调用接口的http或https的函数调用类
+- ~~HttpCall 全局的CHttpCall对象~~
+- ~~CHttpCall 提供api调用接口的http或https的函数调用类~~
 - watchRequire 监控文化变化的函数
@@ -28,3 +28,3 @@ - SimpleCode 一种换位加编码的类
 - codeUtils 一些编码相关的函数，有md5，sha254，base64等函数
-- error_common,error_utils 通用错误信息和错误相关函数
+- error_common, error_utils 通用错误信息和错误相关函数
 - common_ret 通用返回的类
@@ -36,2 +36,7 @@ - bitUtils 二进制标志的工具类
 
+## 0.1.8
+- 2021-04-28
+- \- 标注httpcall为@deprecated  计划在未来的版中，准备删除这个
+- \* 为common_ret增加toString等方法内容。
+
 ## 0.1.5 - 0.1.7
@@ -38,0 +43,0 @@ - 2020-12-24

types/xmcommon/index.d.ts

@@ -33,2 +33,3 @@ // Type definitions for xmcommon 0.0
 	 * HttpCall的错误码定义
+     * @deprecated
 	 */
@@ -628,2 +629,13 @@ interface HttpCallError{
 	}
+    //通用的数据返回接口
+    interface ICommonRet {
+        /** 判断是否成功 true表示成功，false表示失败 */
+        isOK : boolean
+        /** 错误码 */
+        err  : number;
+        /** 错误信息 */
+        msg ?: string;
+        /** 携带数据 */
+        data?: any;
+    }
 
@@ -737,3 +749,9 @@ //通用的数据返回
 		 */
+
+
 		setErrorFromMsghead(head: any): common_ret;
+        /**
+         * 重载toJSON，返回ICommonRet对象
+         */
+        toJSON():ICommonRet;
 		//一组属性
@@ -745,2 +763,4 @@ readonly isOK:boolean;
 		readonly isFalse:boolean;
+
+
 	}
@@ -747,0 +767,0 @@

No alert changes

Improved metrics

Total package byte prevSize

142282

increased by0.8%

Lines of code

4114

increased by1.01%

Number of lines in readme file

240

increased by2.13%

No dependency changes