xctc-utils 1.5.3 → 1.5.5

package/README.md

@@ -1,29 +1,34 @@
 ### 项目中常用的方法集合
 #### email： dybself@163.com
 #### 安装 npm i xctc-utils
-#### 项目中引入 import utils from "xctc-utils"
+#### 项目中引入 import useUtils from "xctc-utils"
 
 
 #### LocalStorage使用，存取值时数据已经过处理
 ```
-存储： utils.useLocalStorage(key,value)
-取值： utils.getLocalStorage(key)
+存储： useUtils.useLocalStorage(key,value)
+取值： useUtils.getLocalStorage(key)
 ```
 
 #### sessionStorage使用，存取值时数据已经过处理
 ```
 
-存储： utils.useSessionStorage(key,value)
-取值： utils.getSessionStorage(key)
+存储： useUtils.useSessionStorage(key,value)
+取值： useUtils.getSessionStorage(key)
 
+```
+
+#### 将数据复制到剪贴板函数
+```
+useUtils.handleCopyValue(val)
 ```
 #### 删除缓存
 ```
 key:string 需要删除的缓存键
 isAll:boolean 为true时删除调用方法的所有缓存，否则只删除当前传入的 key 值
 如果 isAll 为 true 时，方法会优先执行缓存的clear函数， key 传任意值，
-删除临时缓存： utils.removeSessionStorage(key,isAll)
-删除永久缓存： utils.removeLocalStorage(key,isAll)
+删除临时缓存： useUtils.removeSessionStorage(key,isAll)
+删除永久缓存： useUtils.removeLocalStorage(key,isAll)
 
 ```
 #### AES 加密、解密，同一个数据的加密和解密传入的key 和 iv保持一致。
@@ -32,27 +37,27 @@ work： 需要加密的对象，如传入的是对象，该方法默认进行JSO
 key：16位或者32位字符串作为密钥
 iv：16位或者32位字符串作为密钥偏移量
 data： encrypt方法加密后返回的数据
-加密：utils.encrypt( work:any , key:string , iv:string )
-解密：utils.decrypt( data:string , key:string , iv:string )
+加密：useUtils.encrypt( work:any , key:string , iv:string )
+解密：useUtils.decrypt( data:string , key:string , iv:string )
 ```
 #### 类型判断
 ```
-utils.type.isFunction(val) // 是否是函数
-utils.type.isObject(val)   // 是否是对象 null 类型为对象，该方法已对null进行过滤
-utils.type.isDate(val)     // 是否是时间对象
-utils.type.isNumber(val)   // 是否是number类型
-utils.type.isString(val)   // 是否是字符串类型
-utils.type.isBoolean(val)  // 是否是boolean类型
-utils.type.isWindow(val)    // 是否在浏览器环境下运行
+useUtils.type.isFunction(val) // 是否是函数
+useUtils.type.isObject(val)   // 是否是对象 null 类型为对象，该方法已对null进行过滤
+useUtils.type.isDate(val)     // 是否是时间对象
+useUtils.type.isNumber(val)   // 是否是number类型
+useUtils.type.isString(val)   // 是否是字符串类型
+useUtils.type.isBoolean(val)  // 是否是boolean类型
+useUtils.type.isWindow(val)    // 是否在浏览器环境下运行
 
 ```
 #### 获取当前设备环境
 设备环境：
 ```
 
-当前使用设备类型： utils.deviceEnvironment() // android ios
-是否在微信浏览器环境中：  utils.weixinBrowser() // true false
-是否是手持设备： utils.isMobile() // true 移动设备 false PC设备
+当前使用设备类型： useUtils.deviceEnvironment() // android ios
+是否在微信浏览器环境中：  useUtils.weixinBrowser() // true false
+是否是手持设备： useUtils.isMobile() // true 移动设备 false PC设备
 
 ```
 
@@ -67,9 +72,9 @@ data：encrypt方法加密后返回的数据
 对word进行CryptoJS.enc.Utf8.parse转义
 CryptoJS.AES.encrypt加密，加密模式：CBC ； padding： CryptoJS.pad.Pkcs7
 对数据进行加密  
-utils.encrypt(word:any,key:string,iv:string)
+useUtils.encrypt(word:any,key:string,iv:string)
 // 对数据进行解密
-utils.decrypt(data:string,key:string,iv:string)
+useUtils.decrypt(data:string,key:string,iv:string)
 
 ```
 #### 微信H5使用方法集合
@@ -85,7 +90,7 @@ interface configOption {
     cryptokey?:string, // 将地址栏携带参数加密key， 必须与 weixinShareInit 方法中的 key 参数一致
 }
 进入系统时，默认调用该方法，自动执行微信跳转授权，回调地址中code处理、state处理，
-utils.weixinUrlCode(config)
+useUtils.weixinUrlCode(config)
 
 ```
 #### 微信config接口权限注入
@@ -97,7 +102,7 @@ interface ShareConfig{
     jsApiList?:string[],
 }
 
-utils.weixinShareConfig(config:ShareConfig)
+useUtils.weixinShareConfig(config:ShareConfig)
 ```
 
 #### 微信分享接口加载
@@ -111,14 +116,14 @@ interface Share{
     iv?:string, // 分享链接中对 state 数据加密的iv 必须与 weixinUrlCode 方法中的 cryptoiv 参数一致
     key?:string, // 分享链接中对 state 数据加密的 key 必须与 weixinUrlCode 方法中的 cryptokey 参数一致
 }
-utils.weixinShareInit(config:Share)
+useUtils.weixinShareInit(config:Share)
 ```
 
 ### 时间相关方法
 #### 获取当前时间的时间戳
 ```
 
-utils.getTime() // 返回秒
+useUtils.getTime() // 返回秒
 
 ```
 #### 时间戳转任意格式时间字符串
@@ -129,7 +134,7 @@ utils.getTime() // 返回秒
  * @param format 解析后展示时间字符串格式，默认 "YYYY-MM-DD HH:mm:ss" 格式， 可传格式如： YYYY年MM月DD日 HH时 YYYY/MM/DD HH
  * @returns 
  */
-utils.formatTimeStamp(num,format) // 返回 format 格式时间戳
+useUtils.formatTimeStamp(num,format) // 返回 format 格式时间戳
 
 ```
 #### 时间字符串转时间戳
@@ -139,6 +144,6 @@ utils.formatTimeStamp(num,format) // 返回 format 格式时间戳
  * @param str 字符串格式必须为： 2017/03/03 12:23:55 格式，避免兼容性，不能传 “-” 分割的时间字符串 2017-03-03
  * @returns 
  */
-utils.formatStrTime(str) // 返回时间戳 秒
+useUtils.formatStrTime(str) // 返回时间戳 秒
 
 ```

package/dist/format/index.js

@@ -8,6 +8,7 @@ function makePhone(tel) {
     }
 }
 exports.makePhone = makePhone;
+// 将手机号后四位转换为***
 function formatMobile(mobile) {
     if (!mobile)
         return;

package/dist/mobile/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isMobile = void 0;
 var w = window;
+// 是否是手机端环境
 function isMobile() {
     var info = w.navigator.userAgent;
     var isPhone = /mobile/i.test(info);

package/dist/storage/index.d.ts

@@ -1,6 +1,30 @@
+/**
+ *
+ * @param key 需要存储的数据key值
+ * @param value 需要存储的数据
+ * @returns
+ */
 export declare function useLocalStorage(key: string, value: any): false | undefined;
 export declare function getLocalStorage(key: string): any;
+/**
+ *
+ * @param key 需要存储的数据key值
+ * @param value 需要存储的数据
+ * @returns
+ */
 export declare function useSessionStorage(key: string, value: any): false | undefined;
 export declare function getSessionStorage(key: string): any;
+/**
+ *
+ * @param key 需要删除的key值
+ * @param isAll  是否删除所有缓存
+ * @returns
+ */
 export declare function removeSessionStorage(key?: string, isAll?: boolean): void;
+/**
+ *
+ * @param key 需要删除的key值
+ * @param isAll  是否删除所有缓存
+ * @returns
+ */
 export declare function removeLocalStorage(key?: string, isAll?: boolean): void;

package/dist/storage/index.js

@@ -5,6 +5,12 @@ var is_1 = require("../is");
 var wls = window.localStorage;
 var wss = window.sessionStorage;
 var utils_1 = require("../utils");
+/**
+ *
+ * @param key 需要存储的数据key值
+ * @param value 需要存储的数据
+ * @returns
+ */
 function useLocalStorage(key, value) {
     if (!key || !value) {
         console.log("useLocalStorage存储时缺少key:value");
@@ -19,6 +25,12 @@ function getLocalStorage(key) {
     return getStorage(key, wls);
 }
 exports.getLocalStorage = getLocalStorage;
+/**
+ *
+ * @param key 需要存储的数据key值
+ * @param value 需要存储的数据
+ * @returns
+ */
 function useSessionStorage(key, value) {
     if (!key || !value) {
         console.log("useSessionStorage存储时缺少key:value");
@@ -33,6 +45,12 @@ function getSessionStorage(key) {
     return getStorage(key, wss);
 }
 exports.getSessionStorage = getSessionStorage;
+/**
+ *
+ * @param key  需要存储的数据key值
+ * @param value  需要存储的数据
+ * @param obj  localStorage或者sessionStorage对象
+ */
 function useStorage(key, value, obj) {
     if (value instanceof Object) {
         obj.setItem(key, JSON.stringify(value));
@@ -41,6 +59,12 @@ function useStorage(key, value, obj) {
         obj.setItem(key, value);
     }
 }
+/**
+ *
+ * @param key 需要获取的数据key值
+ * @param obj localStorage或者sessionStorage对象
+ * @returns
+ */
 function getStorage(key, obj) {
     var val = obj.getItem(key);
     if (val == 'undefined' || val == null) {
@@ -51,6 +75,12 @@ function getStorage(key, obj) {
         val = data;
     return val;
 }
+/**
+ *
+ * @param key 需要删除的key值
+ * @param isAll  是否删除所有缓存
+ * @returns
+ */
 function removeSessionStorage(key, isAll) {
     if ((0, is_1.isBoolean)(isAll) && isAll) {
         wss.clear();
@@ -61,6 +91,12 @@ function removeSessionStorage(key, isAll) {
     removeStorage(key, wss);
 }
 exports.removeSessionStorage = removeSessionStorage;
+/**
+ *
+ * @param key 需要删除的key值
+ * @param isAll  是否删除所有缓存
+ * @returns
+ */
 function removeLocalStorage(key, isAll) {
     if ((0, is_1.isBoolean)(isAll) && isAll) {
         wls.clear();

package/dist/time/index.js

@@ -19,6 +19,7 @@ exports.getTime = getTime;
 function formatTimeStamp(num, format) {
     if (!format)
         format = "YYYY-MM-DD HH:mm:ss";
+    num = Number(num); // 先将数据转换为数据类型
     if (!num)
         return "";
     // 传入秒 时间戳
@@ -70,8 +71,13 @@ function isExist(str, key) {
 function formatStrTime(str) {
     if (!str)
         return "";
-    var timestamp = new Date(str).getTime();
-    timestamp = timestamp / 1000;
-    return parseInt(timestamp);
+    var strDate = new Date(str);
+    var timestamp = "";
+    if (strDate) {
+        timestamp = strDate.getTime();
+        timestamp = timestamp / 1000;
+        return parseInt(timestamp);
+    }
+    return "";
 }
 exports.formatStrTime = formatStrTime;

package/dist/utils.d.ts

@@ -1,7 +1,26 @@
 import { UeditorHeightOption } from "./types";
+/**
+ * 判断当前传入的字符串是否为 json格式 字符串
+ * @param str
+ * @returns
+ */
 export declare function isJson(str: string): any;
 export declare function $id(id: string): false | HTMLElement;
 export declare function checkIframeContentHeight(option: UeditorHeightOption): string;
 export declare function getIframeContentHeight(id: string): any;
+/**
+ * 判断当前手机端环境
+ * @returns
+ */
 export declare function deviceEnvironment(): string;
+/**
+ * 判断是否是微信内置浏览器
+ * @returns
+ */
 export declare function weixinBrowser(): boolean;
+/**
+ * 将传入的数据复制到粘贴板
+ * @param text
+ * @returns
+ */
+export declare function handleCopyValue(text: string): any;

package/dist/utils.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.weixinBrowser = exports.deviceEnvironment = exports.getIframeContentHeight = exports.checkIframeContentHeight = exports.$id = exports.isJson = void 0;
+exports.handleCopyValue = exports.weixinBrowser = exports.deviceEnvironment = exports.getIframeContentHeight = exports.checkIframeContentHeight = exports.$id = exports.isJson = void 0;
+/**
+ * 判断当前传入的字符串是否为 json格式 字符串
+ * @param str
+ * @returns
+ */
 function isJson(str) {
     if (!str)
         return false;
@@ -67,6 +72,10 @@ function getIframeContentHeight(id) {
     return 0;
 }
 exports.getIframeContentHeight = getIframeContentHeight;
+/**
+ * 判断当前手机端环境
+ * @returns
+ */
 function deviceEnvironment() {
     var u = navigator.userAgent;
     if (u.indexOf('Android') > -1 || u.indexOf('Adr') > -1)
@@ -76,6 +85,10 @@ function deviceEnvironment() {
     return "other";
 }
 exports.deviceEnvironment = deviceEnvironment;
+/**
+ * 判断是否是微信内置浏览器
+ * @returns
+ */
 function weixinBrowser() {
     var ua = navigator.userAgent.toLowerCase();
     var isWeixin = ua.indexOf("micromessenger") != -1;
@@ -87,3 +100,40 @@ function weixinBrowser() {
     }
 }
 exports.weixinBrowser = weixinBrowser;
+// 复制功能
+/**
+ * 将传入的数据复制到粘贴板
+ * @param text
+ * @returns
+ */
+function handleCopyValue(text) {
+    if (!text)
+        return console.error("请传入需要复制到粘贴板的数据");
+    //浏览器禁用了非安全域的 navigator.clipboard 对象
+    //在线上环境会报错 TypeError: Cannot read properties of undefined (reading 'writeText')
+    var clipboard = (navigator === null || navigator === void 0 ? void 0 : navigator.clipboard) || "";
+    if (!clipboard && window.isSecureContext) {
+        return clipboard === null || clipboard === void 0 ? void 0 : clipboard.writeText(text);
+    }
+    else {
+        // 判断是否支持拷贝
+        if (!document.execCommand('copy'))
+            return Promise.reject();
+        // 创建标签，并隐藏
+        var textArea_1 = document.createElement('textarea');
+        textArea_1.style.position = 'fixed';
+        textArea_1.style.top = textArea_1.style.left = '-100vh';
+        textArea_1.style.opacity = '0';
+        textArea_1.value = text;
+        document.body.appendChild(textArea_1);
+        // 聚焦、复制
+        textArea_1.focus();
+        textArea_1.select();
+        return new Promise(function (resolve, reject) {
+            // 不知为何，必须写这个三目，不然copy不上
+            document.execCommand('copy') ? resolve() : reject();
+            textArea_1.remove();
+        });
+    }
+}
+exports.handleCopyValue = handleCopyValue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xctc-utils",
-  "version": "1.5.3",
+  "version": "1.5.5",
   "description": "localStorage存储\r ```\r sessionStorage存储\r ```\r crypto-js加密、解密\r ```\r 微信授权登录、微信分享\r ```\r 设备环境获取\r ```\r 是否是微信浏览器\r ```\r 时间戳转时间，字符串转时间戳",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",