xmcommon - npm Package Compare versions

Comparing version 0.9.2 to 0.9.3

dist/common_ret.d.ts

@@ -7,3 +7,3 @@ import { error_common } from './constant';
     msg: string;
-    data: T;
+    data: T | null;
     isOK: boolean;
@@ -20,6 +20,7 @@ }
  * 这个类主要是增加了错误判断的属性,可以做为一个通用的返回类
- * 要返回的数据可以通过data属性返回
+ * - 但是这里的数据类型都any类型的，不建议使用，所以这里新增加带模板的XCommonRet<T>类，两个功能接口完全一样
+ * - 要返回的数据可以通过data属性返回
  * 有isOK,isNotOK,isFail三个属性来简化返回结果.
  */
-export declare class common_ret implements ICommonRetData {
+export declare class common_ret implements ICommonRetData<any> {
     private m_err;
@@ -81,3 +82,3 @@ private m_msg;
      * 设置携带的数据
-     * @param paramData=null 数据
+     * @param paramData 数据
      */
@@ -104,3 +105,3 @@ setData(paramData?: null): void;
      * 设为ERR_TRUE
-     * @return {common_ret} 返回this
+     * @return 返回this
      */
@@ -110,3 +111,3 @@ setTrue(): common_ret;
      * 设为ERR_FALSE
-     * @return {common_ret} 返回this
+     * @return 返回this
      */
@@ -141,5 +142,129 @@ setFalse(): common_ret;
      * 重载toJSON方法
-     * @return {{isOK: boolean, err: number, msg: string, data: object}} 返回非类的对象
+     * @return 返回非类的对象
      */
     toJSON(): ICommonRetData;
 }
+/**
+ * 这是一个新增的通用返回类, 因为common_ret已经在很多项目使用了，变更它的设计可能会引用很多问题，所以
+ * 在这里重新定一个带模板的通用返回类
+ * 要返回的数据可以通过data属性返回
+ * 有isOK,isNotOK,isFail三个属性来简化返回结果.
+ */
+export declare class XCommonRet<T = any> implements ICommonRetData<T> {
+    private m_err;
+    private m_msg;
+    private m_data;
+    /**
+     * 构造函数
+     * @param paramErr 错误码
+     * @param paramMsg 错误信息
+     * @param paramData 携带数据
+     */
+    constructor(paramErr?: number, paramMsg?: string, paramData?: any);
+    /**
+     * 设置错误信息
+     * @param paramErr 错误码 @see error_common定义
+     * @param paramMsg 错误信息
+     * @param paramData 数据
+     * @param paramMsgPre 错误信息前缀 相当于执于了一次addErrorPre
+     * @return 返回当前this
+     */
+    setError(paramErr: number, paramMsg?: string, paramData?: T | null, paramMsgPre?: string | null): XCommonRet<T>;
+    /**
+     * 取错信息
+     * @return 返回含有错误码的错误信息
+     */
+    getErrorInfo(): string;
+    /**
+     * 设置错误信息
+     * @param paramMsg 设备错误信息
+     * @param paramMsgPre 错误信息前缀
+     */
+    setErrorMsg(paramMsg?: string, paramMsgPre?: string | null): void;
+    /**
+     * 取错误信息
+     * @return 返回错误信息
+     */
+    getErrorMsg(): string;
+    get msg(): string;
+    set msg(paramMsg: string);
+    /**
+     * 取错误码
+     * @return  返回错误码
+     */
+    getErrorCode(): number;
+    get err(): number;
+    set err(paramErr: number);
+    /**
+     *
+     * @param err 置错误码
+     */
+    setErrorCode(err?: error_common): void;
+    /**
+     * 取携带数据
+     * @return 携带的数据
+     */
+    getData(): T | null;
+    /**
+     * 设置携带的数据
+     * @param paramData=null 数据
+     */
+    setData(paramData?: T | null): void;
+    get data(): T | null;
+    set data(paramData: T | null);
+    /**
+     * 设置错误信息为ERR_OK;
+     */
+    setErrorCodeOK(): XCommonRet<T>;
+    /**
+     * 设为失败
+     * @return 返回this
+     */
+    setErrorCodeFail(): XCommonRet<T>;
+    /**
+     * 设为OK
+     * @param data 携带的数据
+     * @return 返回this
+     */
+    setOK(data?: null): XCommonRet<T>;
+    /**
+     * 设为ERR_TRUE
+     * @return  返回当前对象
+     */
+    setTrue(): XCommonRet<T>;
+    /**
+     * 设为ERR_FALSE
+     * @return 返回当前对象
+     */
+    setFalse(): XCommonRet<T>;
+    /**
+     * 增加错误信息前缀
+     * @param paramMsgPre 前缀
+     * @return 返回this
+     */
+    addErrorPre(paramMsgPre: string): XCommonRet<T>;
+    /**
+     * 将错误信息复制到msgHead
+     * 这个是专门针对协议中的msgHead
+     * @param paramHead 用于保存的消息头
+     * @return 返回this
+     */
+    copyTo(paramHead: ICommonMsgHead): XCommonRet<T>;
+    /**
+     * 将错误信息从head复制过来
+     * 这个是专门针对协议中的msgHead
+     * @param paramHead 消息头
+     * @return 返回this
+     */
+    setErrorFromMsghead(paramHead: ICommonMsgHead): XCommonRet<T>;
+    get isOK(): boolean;
+    get isNotOK(): boolean;
+    get isFail(): boolean;
+    get isTrue(): boolean;
+    get isFalse(): boolean;
+    /**
+     * 重载toJSON方法
+     * @return 返回非类的对象
+     */
+    toJSON(): ICommonRetData<T>;
+}

dist/common_ret.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.common_ret = void 0;
+exports.XCommonRet = exports.common_ret = void 0;
 const common_error_1 = require("./common_error");
 const constant_1 = require("./constant");
+const utils_1 = require("./utils");
 // 通用的数据返回
 /**
  * 这个类主要是增加了错误判断的属性,可以做为一个通用的返回类
- * 要返回的数据可以通过data属性返回
+ * - 但是这里的数据类型都any类型的，不建议使用，所以这里新增加带模板的XCommonRet<T>类，两个功能接口完全一样
+ * - 要返回的数据可以通过data属性返回
  * 有isOK,isNotOK,isFail三个属性来简化返回结果.
@@ -23,2 +25,3 @@ */
         this.m_msg = '';
+        this.m_data = null;
         this.m_err = paramErr; // 错误码
@@ -114,2 +117,222 @@ this.m_msg = paramMsg; // 错误信息
      * 设置携带的数据
+     * @param paramData 数据
+     */
+    setData(paramData = null) {
+        this.m_data = paramData;
+    }
+    get data() {
+        return this.m_data;
+    }
+    set data(paramData) {
+        this.m_data = paramData;
+    }
+    /**
+     * 设置错误信息为ERR_OK;
+     */
+    setErrorCodeOK() {
+        this.m_err = constant_1.error_common.ERR_OK;
+        return this;
+    }
+    /**
+     * 设为失败
+     * @return 返回this
+     */
+    setErrorCodeFail() {
+        this.m_err = constant_1.error_common.ERR_FAIL;
+        return this;
+    }
+    /**
+     * 设为OK
+     * @param data 携带的数据
+     * @return 返回this
+     */
+    setOK(data = null) {
+        this.m_err = constant_1.error_common.ERR_OK;
+        this.m_data = data;
+        return this;
+    }
+    /**
+     * 设为ERR_TRUE
+     * @return 返回this
+     */
+    setTrue() {
+        this.m_err = constant_1.error_common.ERR_TRUE;
+        return this;
+    }
+    /**
+     * 设为ERR_FALSE
+     * @return 返回this
+     */
+    setFalse() {
+        this.m_err = constant_1.error_common.ERR_FALSE;
+        return this;
+    }
+    /**
+     * 增加错误信息前缀
+     * @param paramMsgPre 前缀
+     * @return 返回this
+     */
+    addErrorPre(paramMsgPre) {
+        this.m_msg = `${paramMsgPre}${this.m_msg}`;
+        return this;
+    }
+    /**
+     * 将错误信息复制到msgHead
+     * 这个是专门针对协议中的msgHead
+     * @param paramHead 用于保存的消息头
+     * @return 返回this
+     */
+    copyTo(paramHead) {
+        paramHead.err = this.m_err;
+        paramHead.errmsg = this.m_msg;
+        return this;
+    }
+    /**
+     * 将错误信息从head复制过来
+     * 这个是专门针对协议中的msgHead
+     * @param paramHead 消息头
+     * @return 返回this
+     */
+    setErrorFromMsghead(paramHead) {
+        this.m_err = paramHead.err;
+        this.m_msg = paramHead.errmsg;
+        return this;
+    }
+    //
+    get isOK() {
+        return common_error_1.error_utils.isOK(this.m_err);
+    }
+    get isNotOK() {
+        return common_error_1.error_utils.isNotOK(this.m_err);
+    }
+    get isFail() {
+        return common_error_1.error_utils.isFail(this.m_err);
+    }
+    get isTrue() {
+        return common_error_1.error_utils.isTrue(this.m_err);
+    }
+    get isFalse() {
+        return common_error_1.error_utils.isFalse(this.m_err);
+    }
+    /**
+     * 重载toJSON方法
+     * @return 返回非类的对象
+     */
+    toJSON() {
+        return {
+            isOK: this.isOK,
+            err: this.m_err,
+            msg: this.m_msg,
+            data: this.m_data,
+        };
+    }
+}
+exports.common_ret = common_ret;
+/**
+ * 这是一个新增的通用返回类, 因为common_ret已经在很多项目使用了，变更它的设计可能会引用很多问题，所以
+ * 在这里重新定一个带模板的通用返回类
+ * 要返回的数据可以通过data属性返回
+ * 有isOK,isNotOK,isFail三个属性来简化返回结果.
+ */
+// tslint:disable-next-line: class-name
+class XCommonRet {
+    /**
+     * 构造函数
+     * @param paramErr 错误码
+     * @param paramMsg 错误信息
+     * @param paramData 携带数据
+     */
+    constructor(paramErr = constant_1.error_common.ERR_OK, paramMsg = '', paramData = null) {
+        this.m_err = constant_1.error_common.ERR_OK;
+        this.m_msg = '';
+        this.m_err = paramErr; // 错误码
+        this.m_msg = paramMsg; // 错误信息
+        this.m_data = paramData; // 返回的数据,默认空数据
+    }
+    /**
+     * 设置错误信息
+     * @param paramErr 错误码 @see error_common定义
+     * @param paramMsg 错误信息
+     * @param paramData 数据
+     * @param paramMsgPre 错误信息前缀 相当于执于了一次addErrorPre
+     * @return 返回当前this
+     */
+    setError(paramErr, paramMsg = '', paramData = null, paramMsgPre = null) {
+        this.m_err = paramErr;
+        if (utils_1.utils.isNotNull(paramMsgPre)) {
+            this.m_msg = `${paramMsgPre}${paramMsg}`;
+        }
+        else {
+            this.m_msg = paramMsg;
+        }
+        this.m_data = paramData;
+        return this;
+    }
+    /**
+     * 取错信息
+     * @return 返回含有错误码的错误信息
+     */
+    getErrorInfo() {
+        if (this.isNotOK) {
+            return `[${this.m_err}] ${this.m_msg}`;
+        }
+        else {
+            return '';
+        }
+    }
+    /**
+     * 设置错误信息
+     * @param paramMsg 设备错误信息
+     * @param paramMsgPre 错误信息前缀
+     */
+    setErrorMsg(paramMsg = '', paramMsgPre = null) {
+        if (utils_1.utils.isNotNull(paramMsgPre)) {
+            this.m_msg = `${paramMsgPre}${paramMsg}`;
+        }
+        else {
+            this.m_msg = paramMsg;
+        }
+    }
+    /**
+     * 取错误信息
+     * @return 返回错误信息
+     */
+    getErrorMsg() {
+        return this.m_msg;
+    }
+    get msg() {
+        return this.m_msg;
+    }
+    set msg(paramMsg) {
+        this.m_msg = paramMsg;
+    }
+    /**
+     * 取错误码
+     * @return  返回错误码
+     */
+    getErrorCode() {
+        return this.m_err;
+    }
+    get err() {
+        return this.m_err;
+    }
+    set err(paramErr) {
+        this.m_err = paramErr;
+    }
+    /**
+     *
+     * @param err 置错误码
+     */
+    setErrorCode(err = constant_1.error_common.ERR_OK) {
+        this.m_err = err;
+    }
+    /**
+     * 取携带数据
+     * @return 携带的数据
+     */
+    getData() {
+        return this.m_data;
+    }
+    /**
+     * 设置携带的数据
      * @param paramData=null 数据
@@ -153,3 +376,3 @@ */
      * 设为ERR_TRUE
-     * @return {common_ret} 返回this
+     * @return  返回当前对象
      */
@@ -162,3 +385,3 @@ setTrue() {
      * 设为ERR_FALSE
-     * @return {common_ret} 返回this
+     * @return 返回当前对象
      */
@@ -218,3 +441,3 @@ setFalse() {
      * 重载toJSON方法
-     * @return {{isOK: boolean, err: number, msg: string, data: object}} 返回非类的对象
+     * @return 返回非类的对象
      */
@@ -230,2 +453,2 @@ toJSON() {
 }
-exports.common_ret = common_ret;
+exports.XCommonRet = XCommonRet;

lib/common_ret.ts

@@ -1,3 +0,4 @@
-import {error_utils} from './common_error';
-import {error_common} from './constant';
+import { error_utils } from './common_error';
+import { error_common } from './constant';
+import { utils } from './utils';
 
@@ -9,3 +10,3 @@ /** 通用返回接口 */
     msg : string;
-    data: T;
+    data: T | null;
     isOK: boolean;
@@ -16,3 +17,3 @@ }
     /** 错误码 */
-    err : number;
+    err    : number;
     /** 错误信息 */
@@ -25,10 +26,11 @@ errmsg : string;
  * 这个类主要是增加了错误判断的属性,可以做为一个通用的返回类
- * 要返回的数据可以通过data属性返回
+ * - 但是这里的数据类型都any类型的，不建议使用，所以这里新增加带模板的XCommonRet<T>类，两个功能接口完全一样
+ * - 要返回的数据可以通过data属性返回
  * 有isOK,isNotOK,isFail三个属性来简化返回结果.
  */
 // tslint:disable-next-line: class-name
-export class common_ret implements ICommonRetData {
-    private m_err: number = error_common.ERR_OK;
-    private m_msg: string = '';
-    private m_data: any;
+export class common_ret implements ICommonRetData<any> {
+    private m_err : number = error_common.ERR_OK;
+    private m_msg : string = '';
+    private m_data: any    = null;
     /**
@@ -41,5 +43,5 @@ * 构造函数
     public constructor(paramErr: number = error_common.ERR_OK, paramMsg: string = '', paramData: any = null) {
-        this.m_err = paramErr; // 错误码
-        this.m_msg = paramMsg; // 错误信息
-        this.m_data = paramData; // 返回的数据,默认空数据
+        this.m_err  = paramErr;   // 错误码
+        this.m_msg  = paramMsg;   // 错误信息
+        this.m_data = paramData;  // 返回的数据,默认空数据
     }
@@ -134,3 +136,3 @@ /**
      * 设置携带的数据
-     * @param paramData=null 数据
+     * @param paramData 数据
      */
@@ -168,3 +170,3 @@ public setData(paramData = null) {
     public setOK(data = null): common_ret {
-        this.m_err = error_common.ERR_OK;
+        this.m_err  = error_common.ERR_OK;
         this.m_data = data;
@@ -175,3 +177,3 @@ return this;
      * 设为ERR_TRUE
-     * @return {common_ret} 返回this
+     * @return 返回this
      */
@@ -184,3 +186,3 @@ public setTrue(): common_ret {
      * 设为ERR_FALSE
-     * @return {common_ret} 返回this
+     * @return 返回this
      */
@@ -207,3 +209,3 @@ public setFalse(): common_ret {
     public copyTo(paramHead: ICommonMsgHead): common_ret {
-        paramHead.err = this.m_err;
+        paramHead.err    = this.m_err;
         paramHead.errmsg = this.m_msg;
@@ -241,3 +243,3 @@ return this;
      * 重载toJSON方法
-     * @return {{isOK: boolean, err: number, msg: string, data: object}} 返回非类的对象
+     * @return 返回非类的对象
      */
@@ -247,4 +249,4 @@ public toJSON(): ICommonRetData {
             isOK: this.isOK,
-            err: this.m_err,
-            msg: this.m_msg,
+            err : this.m_err,
+            msg : this.m_msg,
             data: this.m_data,
@@ -254,1 +256,226 @@ };
 }
+
+
+/**
+ * 这是一个新增的通用返回类, 因为common_ret已经在很多项目使用了，变更它的设计可能会引用很多问题，所以
+ * 在这里重新定一个带模板的通用返回类
+ * 要返回的数据可以通过data属性返回
+ * 有isOK,isNotOK,isFail三个属性来简化返回结果.
+ */
+// tslint:disable-next-line: class-name
+export class XCommonRet<T = any> implements ICommonRetData<T> {
+    private m_err: number = error_common.ERR_OK;
+    private m_msg: string = '';
+    private m_data: T | null;
+    /**
+     * 构造函数
+     * @param paramErr 错误码
+     * @param paramMsg 错误信息
+     * @param paramData 携带数据
+     */
+    public constructor(paramErr: number = error_common.ERR_OK, paramMsg: string = '', paramData: any = null) {
+        this.m_err  = paramErr;   // 错误码
+        this.m_msg  = paramMsg;   // 错误信息
+        this.m_data = paramData;  // 返回的数据,默认空数据
+    }
+    /**
+     * 设置错误信息
+     * @param paramErr 错误码 @see error_common定义
+     * @param paramMsg 错误信息
+     * @param paramData 数据
+     * @param paramMsgPre 错误信息前缀 相当于执于了一次addErrorPre
+     * @return 返回当前this
+     */
+    public setError(paramErr: number, paramMsg: string = '', paramData: T | null = null, paramMsgPre: string | null = null): XCommonRet<T>  {
+        this.m_err = paramErr;
+        if (utils.isNotNull(paramMsgPre)) {
+            this.m_msg = `${paramMsgPre}${paramMsg}`;
+        } else {
+            this.m_msg = paramMsg;
+        }
+        this.m_data = paramData;
+        return this;
+    }
+    /**
+     * 取错信息
+     * @return 返回含有错误码的错误信息
+     */
+    public getErrorInfo(): string {
+        if (this.isNotOK) {
+            return `[${this.m_err}] ${this.m_msg}`;
+        } else {
+            return '';
+        }
+    }
+
+    /**
+     * 设置错误信息
+     * @param paramMsg 设备错误信息
+     * @param paramMsgPre 错误信息前缀
+     */
+    public setErrorMsg(paramMsg: string = '', paramMsgPre: string | null = null): void {
+        if (utils.isNotNull(paramMsgPre)) {
+            this.m_msg = `${paramMsgPre}${paramMsg}`;
+        } else {
+            this.m_msg = paramMsg;
+        }
+    }
+    /**
+     * 取错误信息
+     * @return 返回错误信息
+     */
+    public getErrorMsg(): string {
+        return this.m_msg;
+    }
+    public get msg() {
+        return this.m_msg;
+    }
+    public set msg(paramMsg: string) {
+        this.m_msg = paramMsg;
+    }
+
+    /**
+     * 取错误码
+     * @return  返回错误码
+     */
+    public getErrorCode() {
+        return this.m_err;
+    }
+
+    public get err() {
+        return this.m_err;
+    }
+
+    public set err(paramErr: number) {
+        this.m_err = paramErr;
+    }
+    /**
+     *
+     * @param err 置错误码
+     */
+    public setErrorCode(err = error_common.ERR_OK): void {
+        this.m_err = err;
+    }
+
+    /**
+     * 取携带数据
+     * @return 携带的数据
+     */
+    public getData() {
+        return this.m_data;
+    }
+    /**
+     * 设置携带的数据
+     * @param paramData=null 数据
+     */
+    public setData(paramData: T | null = null) {
+        this.m_data = paramData;
+    }
+    public get data(): T | null {
+        return this.m_data;
+    }
+    public set data(paramData: T | null) {
+        this.m_data = paramData;
+    }
+
+    /**
+     * 设置错误信息为ERR_OK;
+     */
+    public setErrorCodeOK(): XCommonRet<T> {
+        this.m_err = error_common.ERR_OK;
+        return this;
+    }
+    /**
+     * 设为失败
+     * @return 返回this
+     */
+    public setErrorCodeFail(): XCommonRet<T> {
+        this.m_err = error_common.ERR_FAIL;
+        return this;
+    }
+    /**
+     * 设为OK
+     * @param data 携带的数据
+     * @return 返回this
+     */
+    public setOK(data = null): XCommonRet<T> {
+        this.m_err  = error_common.ERR_OK;
+        this.m_data = data;
+        return this;
+    }
+    /**
+     * 设为ERR_TRUE
+     * @return  返回当前对象
+     */
+    public setTrue(): XCommonRet<T> {
+        this.m_err = error_common.ERR_TRUE;
+        return this;
+    }
+    /**
+     * 设为ERR_FALSE
+     * @return 返回当前对象
+     */
+    public setFalse(): XCommonRet<T> {
+        this.m_err = error_common.ERR_FALSE;
+        return this;
+    }
+    /**
+     * 增加错误信息前缀
+     * @param paramMsgPre 前缀
+     * @return 返回this
+     */
+    public addErrorPre(paramMsgPre: string): XCommonRet<T> {
+        this.m_msg =`${paramMsgPre}${this.m_msg}`;
+        return this;
+    }
+    /**
+     * 将错误信息复制到msgHead
+     * 这个是专门针对协议中的msgHead
+     * @param paramHead 用于保存的消息头
+     * @return 返回this
+     */
+    public copyTo(paramHead: ICommonMsgHead): XCommonRet<T> {
+        paramHead.err    = this.m_err;
+        paramHead.errmsg = this.m_msg;
+        return this;
+    }
+    /**
+     * 将错误信息从head复制过来
+     * 这个是专门针对协议中的msgHead
+     * @param paramHead 消息头
+     * @return 返回this
+     */
+    public setErrorFromMsghead(paramHead: ICommonMsgHead): XCommonRet<T> {
+        this.m_err = paramHead.err;
+        this.m_msg = paramHead.errmsg;
+        return this;
+    }
+    //
+    public get isOK(): boolean {
+        return error_utils.isOK(this.m_err);
+    }
+    public get isNotOK(): boolean {
+        return error_utils.isNotOK(this.m_err);
+    }
+    public get isFail(): boolean {
+        return error_utils.isFail(this.m_err);
+    }
+    public get isTrue(): boolean {
+        return error_utils.isTrue(this.m_err);
+    }
+    public get isFalse(): boolean {
+        return error_utils.isFalse(this.m_err);
+    }
+    /**
+     * 重载toJSON方法
+     * @return 返回非类的对象
+     */
+    public toJSON(): ICommonRetData<T> {
+        return {
+            isOK: this.isOK,
+            err : this.m_err,
+            msg : this.m_msg,
+            data: this.m_data,
+        };
+    }
+}

package.json

 {
     "name": "xmcommon",
-    "version": "0.9.2",
+    "version": "0.9.3",
     "description": "javascript common lib for es6",
@@ -23,3 +23,7 @@ "main": "./dist/index.js",
             "type": "MIT",
-            "url": "https://github.com/zdhsoft/xmcommon/blob/master/LICENSE"
+            "url": "https://www.opensource.org/licenses/mit-license.php"
+        },
+        {
+            "type": "Apache-2.0",
+            "url": "https://opensource.org/licenses/apache2.0.php"
         }
@@ -26,0 +30,0 @@ ],

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

295913

increased by5.74%

Lines of code

8198

increased by7.43%

Worsened metrics

Number of low license alerts

1

increased byInfinity%

No dependency changes