xmcommon - npm Package Compare versions

Comparing version 0.9.16 to 0.9.17

dist/utils.d.ts

@@ -392,2 +392,37 @@ /// <reference types="node" />
     /**
+     * 检查value是否是字符串，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    static stringOpts(paramValue: unknown, paramDefault: string): string;
+    /**
+     * 检查value是否是整数，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    static intOpts(paramValue: unknown, paramDefault: number): number;
+    /**
+     * 检查value是否是数字，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    static numberOpts(paramValue: unknown, paramDefault: number): number;
+    /**
+     * 检查value是否是boolean，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    static boolOpts(paramValue: unknown, paramDefault: boolean): boolean;
+    /**
+     * 检查value是否是对象，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    static objectOpts(paramValue: unknown, paramDefault: unknown): unknown;
+    /**
      * 随机一个整数
@@ -412,2 +447,9 @@ * @return
     /**
+     * 限制字符串的长度，超过则自动截取，如果传入字符串为null或undefined,则返回缺省字符串
+     * @param paramString 要检查的字符串
+     * @param paramMaxLength 最大字符数
+     * @param paramDefault 缺省字符串
+     */
+    static limitString(paramString: string, paramMaxLength?: number, paramDefault?: string): string;
+    /**
      * 计算页信息
@@ -414,0 +456,0 @@ * - 与mysql limit相对应

dist/utils.js

@@ -799,2 +799,47 @@ "use strict";
     /**
+     * 检查value是否是字符串，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    static stringOpts(paramValue, paramDefault) {
+        return lodash_1.default.isString(paramValue) ? paramValue : paramDefault;
+    }
+    /**
+     * 检查value是否是整数，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    static intOpts(paramValue, paramDefault) {
+        return Number.isInteger(paramValue) ? paramValue : paramDefault;
+    }
+    /**
+     * 检查value是否是数字，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    static numberOpts(paramValue, paramDefault) {
+        return lodash_1.default.isNumber(paramValue) ? paramValue : paramDefault;
+    }
+    /**
+     * 检查value是否是boolean，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    static boolOpts(paramValue, paramDefault) {
+        return lodash_1.default.isBoolean(paramValue) ? paramValue : paramDefault;
+    }
+    /**
+     * 检查value是否是对象，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    static objectOpts(paramValue, paramDefault) {
+        return lodash_1.default.isObject(paramValue) ? paramValue : paramDefault;
+    }
+    /**
      * 随机一个整数
@@ -825,2 +870,21 @@ * @return
     /**
+     * 限制字符串的长度，超过则自动截取，如果传入字符串为null或undefined,则返回缺省字符串
+     * @param paramString 要检查的字符串
+     * @param paramMaxLength 最大字符数
+     * @param paramDefault 缺省字符串
+     */
+    static limitString(paramString, paramMaxLength, paramDefault = '') {
+        const defaultString = utils.isNull(paramDefault) ? '' : paramDefault;
+        let v = utils.isNull(paramString) ? defaultString : paramString;
+        if (utils.isInteger(paramMaxLength) && paramMaxLength >= 0) {
+            if (paramMaxLength === 0) {
+                v = '';
+            }
+            else if (v.length > paramMaxLength) {
+                v = v.substring(0, paramMaxLength);
+            }
+        }
+        return v;
+    }
+    /**
      * 计算页信息
@@ -827,0 +891,0 @@ * - 与mysql limit相对应

lib/utils.ts

@@ -839,3 +839,49 @@ /* eslint-disable @typescript-eslint/no-explicit-any */
     }
+
     /**
+     * 检查value是否是字符串，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    public static stringOpts(paramValue: unknown, paramDefault: string): string {
+        return _.isString(paramValue) ? (paramValue as string) : paramDefault;
+    }
+    /**
+     * 检查value是否是整数，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    public static intOpts(paramValue: unknown, paramDefault: number): number {
+        return Number.isInteger(paramValue) ? (paramValue as number) : paramDefault;
+    }
+    /**
+     * 检查value是否是数字，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    public static numberOpts(paramValue: unknown, paramDefault: number): number {
+        return _.isNumber(paramValue) ? (paramValue as number) : paramDefault;
+    }
+    /**
+     * 检查value是否是boolean，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    public static boolOpts(paramValue: unknown, paramDefault: boolean): boolean {
+        return _.isBoolean(paramValue) ? (paramValue as boolean) : paramDefault;
+    }
+    /**
+     * 检查value是否是对象，不是则返回缺省值
+     * @param paramValue 被检查的值
+     * @param paramDefault 缺省值
+     * @returns
+     */
+    public static objectOpts(paramValue: unknown, paramDefault: unknown): unknown {
+        return _.isObject(paramValue) ? paramValue : paramDefault;
+    }
+    /**
      * 随机一个整数
@@ -865,4 +911,21 @@ * @return
     }
-
     /**
+     * 限制字符串的长度，超过则自动截取，如果传入字符串为null或undefined,则返回缺省字符串
+     * @param paramString 要检查的字符串
+     * @param paramMaxLength 最大字符数
+     * @param paramDefault 缺省字符串
+     */
+    public static limitString(paramString: string, paramMaxLength?: number, paramDefault = '' ): string {
+        const defaultString = utils.isNull(paramDefault)? '' : paramDefault;
+        let v = utils.isNull(paramString)? defaultString: paramString;
+        if (utils.isInteger(paramMaxLength) && (paramMaxLength as number) >= 0) {
+            if (paramMaxLength === 0) {
+                v = '';
+            } else if (v.length > (paramMaxLength as number)) {
+                v = v.substring(0, paramMaxLength);
+            }
+        }
+        return v;
+    }
+    /**
      * 计算页信息
@@ -869,0 +932,0 @@ * - 与mysql limit相对应

package.json

 {
     "name": "xmcommon",
-    "version": "0.9.16",
+    "version": "0.9.17",
     "description": "一个基于javascript的常用功能扩展库! 使用TypeScript重构!",
@@ -5,0 +5,0 @@ "main": "./dist/index.js",

README.md

@@ -40,2 +40,7 @@ # xmcommon
 
+## 0.9.17
+- 2022-01-22
+- \+ utils增加一组选项默认值方法 stringOpts, intOpts, numberOpts, boolOpts, objectOpts, 当传入参数不是指定类型时，会返回默认值
+- \+ utils增加一个方法limitString，超过指定的长度，会自动截取指定的长度
+
 ## 0.9.16
@@ -42,0 +47,0 @@ - 2022-01-07

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

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

315726

increased by2.24%

Lines of code

8699

increased by1.98%

Number of lines in readme file

318

increased by1.6%

No dependency changes