@whitesev/utils 2.11.8 → 2.11.9

package/dist/index.esm.js

@@ -237,7 +237,7 @@ const clearTimeout$1 = (timerId) => loadOrReturnBroker().clearTimeout(timerId);
 const setInterval$1 = (...args) => loadOrReturnBroker().setInterval(...args);
 const setTimeout$1 = (...args) => loadOrReturnBroker().setTimeout(...args);
 
-const version = "2.11.8";
+const version = "2.11.9";
 
 /* eslint-disable */
 // ==UserScript==
@@ -8339,6 +8339,20 @@ class Utils {
      * 深度获取对象的某个属性
      * @param target 待获取的对象
      * @param handler 获取属性的回调
+     * @example
+     * Utils.queryProperty(window,(target)=>{
+     *   if(target.xxx){
+     *     return {
+     *       isFind: true,
+     *       data: target.xxx,
+     *     }
+     *   }else{
+     *     return {
+     *       isFind: false,
+     *       data: target.aabbcc,
+     *     }
+     *   }
+     * })
      */
     queryProperty(target, handler) {
         if (target == null) {
@@ -8354,10 +8368,23 @@ class Utils {
      * 异步-深度获取对象属性
      * @param target 待获取的对象
      * @param handler 获取属性的回调
+     * @example
+     * Utils.asyncQueryProperty(window, async (target)=>{
+     *   if(target.xxx){
+     *     return {
+     *       isFind: true,
+     *       data: target.xxx,
+     *     }
+     *   }else{
+     *     return {
+     *       isFind: false,
+     *       data: target.aabbcc,
+     *     }
+     *   }
+     * })
      */
     async asyncQueryProperty(target, handler) {
         if (target == null) {
-            // @ts-expect-error 空返回
             return;
         }
         const handleResult = await handler(target);
@@ -8369,7 +8396,8 @@ class Utils {
     /**
      * 创建一个新的Utils实例
      * @param option
-     * @returns
+     * @example
+     * Utils.createUtils();
      */
     createUtils(option) {
         return new Utils(option);
@@ -8437,7 +8465,9 @@ class Utils {
     /**
      * 覆盖对象中的函数this指向
      * @param target 需要覆盖的对象
-     * @param [objectThis] 覆盖的this指向，如果为传入，则默认为对象本身
+     * @param objectThis 覆盖的this指向，如果为传入，则默认为对象本身
+     * @example
+     * Utils.coverObjectFunctionThis({})
      */
     coverObjectFunctionThis = commonUtil.coverObjectFunctionThis.bind(commonUtil);
     /**
@@ -8488,7 +8518,7 @@ class Utils {
     /**
      * 自动使用 Worker 执行 setTimeout
      * @param callback 回调函数
-     * @param [timeout=0] 延迟时间，默认为0
+     * @param timeout 延迟时间，默认为0
      */
     workerSetTimeout(callback, timeout = 0) {
         try {
@@ -8559,6 +8589,10 @@ class Utils {
     /**
      * 判断页面中是否存在`worker-src`的CSP规则
      * @param timeout 超时时间，默认为`1500ms`
+     * @example
+     * Utils.hasWorkerCSP().then((hasCSP) => {
+     *   console.log(hasCSP);
+     * })
      */
     hasWorkerCSP(timeout = 1500) {
         return new Promise((resolve) => {