@dcloudio/uni-app-x 0.7.25 → 0.7.26

package/types/uni/uts-plugin-api/lib/uni-event/utssdk/interface.d.ts

@@ -1,305 +1,312 @@
-type $OnCallback = Function
-export type $On = (eventName: string, callback: $OnCallback) => void
-
-type $OnceCallback = Function
-export type $Once = (eventName: string, callback: $OnceCallback) => void
-
-type $OffCallback = Function
-export type $Off = (eventName: string, callback?: $OffCallback | null) => void
-
-export type $Emit = (eventName: string, args: any | null) => void
-
-export interface Uni {
-    /**
-     * 监听自定义事件。事件可以由 uni.$emit 触发。回调函数会接收 uni.$emit 传递的参数。
-     *
-     * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#on
-     * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#on
-     * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/window/communication.html#on
-     * @uniPlatform {
-     *  "app": {
-     *    "android": {
-     *      "osVer": "5.0",
-     *      "uniVer": "√",
-     *      "unixVer": "3.91"
-     *    },
-     *    "ios": {
-     *      "osVer": "12.0",
-     *      "uniVer": "√",
-     *      "unixVer": "4.11"
-     *    },
-     *    "harmony": {
-     *      "osVer": "3.0",
-     *      "uniVer": "4.23",
-     *      "unixVer": "x"
-     *    }
-     *  },
-     *  "mp": {
-     *    "weixin": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "alipay": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "baidu": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "toutiao": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "lark": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "qq": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "kuaishou": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "jd": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    }
-     *  },
-     *  "web": {
-     *    "uniVer": "√",
-     *    "unixVer": "4.0"
-     *  }
-     * }
-     */
-    $on(eventName: string, callback: $OnCallback): void
-    /**
-     * 移除自定义事件监听器。如果提供了事件名和回调，则只移除这个回调的监听器。
-     * 4.13+ 开始支持第二个参数为可选，如果仅提供事件名，则移除该事件的所有监听器。
-     * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#off
-     * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#off
-     * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/window/communication.html#off
-     * @uniPlatform {
-     *  "app": {
-     *    "android": {
-     *      "osVer": "5.0",
-     *      "uniVer": "√",
-     *      "unixVer": "3.91"
-     *    },
-     *    "ios": {
-     *      "osVer": "12.0",
-     *      "uniVer": "√",
-     *      "unixVer": "4.11"
-     *    },
-     *    "harmony": {
-     *      "osVer": "3.0",
-     *      "uniVer": "4.23",
-     *      "unixVer": "x"
-     *    }
-     *  },
-     *  "mp": {
-     *    "weixin": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "alipay": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "baidu": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "toutiao": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "lark": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "qq": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "kuaishou": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "jd": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    }
-     *  },
-     *  "web": {
-     *    "uniVer": "√",
-     *    "unixVer": "4.0"
-     *  }
-     * }
-     */
-    $off(eventName: string, callback?: $OffCallback | null): void
-    /**
-     * 监听一个自定义事件。事件只触发一次，在第一次触发之后移除事件监听器。
-     *
-     * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#once
-     * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#once
-     * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/window/communication.html#once
-     * @uniPlatform {
-     *  "app": {
-     *    "android": {
-     *      "osVer": "5.0",
-     *      "uniVer": "√",
-     *      "unixVer": "3.91"
-     *    },
-     *    "ios": {
-     *      "osVer": "12.0",
-     *      "uniVer": "√",
-     *      "unixVer": "4.11"
-     *    },
-     *    "harmony": {
-     *      "osVer": "3.0",
-     *      "uniVer": "4.23",
-     *      "unixVer": "x"
-     *    }
-     *  },
-     *  "mp": {
-     *    "weixin": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "alipay": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "baidu": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "toutiao": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "lark": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "qq": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "kuaishou": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "jd": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    }
-     *  },
-     *  "web": {
-     *    "uniVer": "√",
-     *    "unixVer": "4.0"
-     *  }
-     * }
-     */
-    $once(eventName: string, callback: $OnceCallback): void
-    /**
-     * 触发自定义事件，附加的参数会传递给事件监听器。
-     *
-     * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
-     * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
-     * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/window/communication.html#emit
-     * @uniPlatform {
-     *  "app": {
-     *    "android": {
-     *      "osVer": "5.0",
-     *      "uniVer": "√",
-     *      "unixVer": "3.91"
-     *    },
-     *    "ios": {
-     *      "osVer": "12.0",
-     *      "uniVer": "√",
-     *      "unixVer": "4.11"
-     *    },
-     *    "harmony": {
-     *      "osVer": "3.0",
-     *      "uniVer": "4.23",
-     *      "unixVer": "x"
-     *    }
-     *  },
-     *  "mp": {
-     *    "weixin": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "alipay": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "baidu": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "toutiao": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "lark": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "qq": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "kuaishou": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    },
-     *    "jd": {
-     *      "hostVer": "√",
-     *      "uniVer": "√",
-     *      "unixVer": "x"
-     *    }
-     *  },
-     *  "web": {
-     *    "uniVer": "√",
-     *    "unixVer": "4.0"
-     *  }
-     * }
-     */
-    $emit(eventName: string, args: any | null): void
-}
+type $OnCallback = Function
+export type $On = (eventName: string, callback: $OnCallback) => void
+
+type $OnceCallback = Function
+export type $Once = (eventName: string, callback: $OnceCallback) => void
+
+type $OffCallback = Function
+export type $Off = (eventName: string, callback?: $OffCallback | null) => void
+
+export type $Emit = (eventName: string, args: any | null) => void
+
+export interface IEventBus {
+    on: $On
+    once: $Once
+    off: $Off
+    emit: $Emit
+}
+
+export interface Uni {
+    /**
+     * 监听自定义事件。事件可以由 uni.$emit 触发。回调函数会接收 uni.$emit 传递的参数。
+     *
+     * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#on
+     * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#on
+     * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/window/communication.html#on
+     * @uniPlatform {
+     *  "app": {
+     *    "android": {
+     *      "osVer": "5.0",
+     *      "uniVer": "√",
+     *      "unixVer": "3.91"
+     *    },
+     *    "ios": {
+     *      "osVer": "12.0",
+     *      "uniVer": "√",
+     *      "unixVer": "4.11"
+     *    },
+     *    "harmony": {
+     *      "osVer": "3.0",
+     *      "uniVer": "4.23",
+     *      "unixVer": "x"
+     *    }
+     *  },
+     *  "mp": {
+     *    "weixin": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "alipay": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "baidu": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "toutiao": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "lark": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "qq": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "kuaishou": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "jd": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    }
+     *  },
+     *  "web": {
+     *    "uniVer": "√",
+     *    "unixVer": "4.0"
+     *  }
+     * }
+     */
+    $on(eventName: string, callback: $OnCallback): void
+    /**
+     * 移除自定义事件监听器。如果提供了事件名和回调，则只移除这个回调的监听器。
+     * 4.13+ 开始支持第二个参数为可选，如果仅提供事件名，则移除该事件的所有监听器。
+     * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#off
+     * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#off
+     * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/window/communication.html#off
+     * @uniPlatform {
+     *  "app": {
+     *    "android": {
+     *      "osVer": "5.0",
+     *      "uniVer": "√",
+     *      "unixVer": "3.91"
+     *    },
+     *    "ios": {
+     *      "osVer": "12.0",
+     *      "uniVer": "√",
+     *      "unixVer": "4.11"
+     *    },
+     *    "harmony": {
+     *      "osVer": "3.0",
+     *      "uniVer": "4.23",
+     *      "unixVer": "x"
+     *    }
+     *  },
+     *  "mp": {
+     *    "weixin": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "alipay": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "baidu": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "toutiao": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "lark": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "qq": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "kuaishou": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "jd": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    }
+     *  },
+     *  "web": {
+     *    "uniVer": "√",
+     *    "unixVer": "4.0"
+     *  }
+     * }
+     */
+    $off(eventName: string, callback?: $OffCallback | null): void
+    /**
+     * 监听一个自定义事件。事件只触发一次，在第一次触发之后移除事件监听器。
+     *
+     * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#once
+     * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#once
+     * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/window/communication.html#once
+     * @uniPlatform {
+     *  "app": {
+     *    "android": {
+     *      "osVer": "5.0",
+     *      "uniVer": "√",
+     *      "unixVer": "3.91"
+     *    },
+     *    "ios": {
+     *      "osVer": "12.0",
+     *      "uniVer": "√",
+     *      "unixVer": "4.11"
+     *    },
+     *    "harmony": {
+     *      "osVer": "3.0",
+     *      "uniVer": "4.23",
+     *      "unixVer": "x"
+     *    }
+     *  },
+     *  "mp": {
+     *    "weixin": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "alipay": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "baidu": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "toutiao": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "lark": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "qq": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "kuaishou": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "jd": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    }
+     *  },
+     *  "web": {
+     *    "uniVer": "√",
+     *    "unixVer": "4.0"
+     *  }
+     * }
+     */
+    $once(eventName: string, callback: $OnceCallback): void
+    /**
+     * 触发自定义事件，附加的参数会传递给事件监听器。
+     *
+     * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+     * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/event-bus.html#emit
+     * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/window/communication.html#emit
+     * @uniPlatform {
+     *  "app": {
+     *    "android": {
+     *      "osVer": "5.0",
+     *      "uniVer": "√",
+     *      "unixVer": "3.91"
+     *    },
+     *    "ios": {
+     *      "osVer": "12.0",
+     *      "uniVer": "√",
+     *      "unixVer": "4.11"
+     *    },
+     *    "harmony": {
+     *      "osVer": "3.0",
+     *      "uniVer": "4.23",
+     *      "unixVer": "x"
+     *    }
+     *  },
+     *  "mp": {
+     *    "weixin": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "alipay": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "baidu": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "toutiao": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "lark": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "qq": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "kuaishou": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    },
+     *    "jd": {
+     *      "hostVer": "√",
+     *      "uniVer": "√",
+     *      "unixVer": "x"
+     *    }
+     *  },
+     *  "web": {
+     *    "uniVer": "√",
+     *    "unixVer": "4.0"
+     *  }
+     * }
+     */
+    $emit(eventName: string, args: any | null): void
+}