@realsee/dnalogel 2.0.1 → 2.2.0-alpha.1

package/dist/shared-utils/Subscribe.d.ts

@@ -1,45 +1,61 @@
-declare const __EVENT__ = "__events__";
+interface EventMap {
+    [name: string]: (...args: any[]) => void | boolean;
+}
 /**
- * 订阅类。
- * 观察者模式（供前端使用），Node端推荐<a href="https://nodejs.org/api/events.html#events_class_eventemitter">EventEmitter</a>。
+ * 监听者模式
+ * @template T - 预设的监听回调类型
+ * @example
+ * ```
+ * new Subscribe<{
+ * "foo": [arg1: number, arg2: string],
+ * "bar": [arg: boolean],
+ * }>()
+ * ```
  */
-export default class Subscribe {
-    private [__EVENT__];
-    constructor();
+declare class Subscribe<T extends EventMap> {
     /**
-     * 判断是否注册时事件
-     * @param  {string|[string]}  name     事件类型
+     * 判断是否注册了事件
+     * @param name - 事件类型
      */
-    hasListener(name: string): any;
+    hasListener(name: keyof T): boolean;
     /**
      * 注册事件
-     * @param  {string|[string]}  names    事件类型
-     * @param  {function}         callback 事件回调函数
-     * @param  {any}              context  事件回调函数调用的上下文
-     * @param  {boolean}          once     是否只执行一次
+     * @param name - 事件类型
+     * @param callback - 事件回调函数
+     * @param once - 是否只执行一次
+     * @returns 解除事件
+     * @template K - 预设的监听事件名称
+     * @template C - 回调函数函数上下文
      */
-    on(names: string | string[], callback: (...args: any[]) => void, context?: any, once?: boolean): () => this;
+    on<K extends keyof T>(name: K, callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>, once?: boolean): () => void;
     /**
      * 注册事件(是否只执行一次)
-     * @param  {string|[string]}  names    事件类型
-     * @param  {function}         callback 事件回调函数
-     * @param  {any}              context  事件回调函数调用的上下文
+     * @param name - 事件类型
+     * @param callback - 事件回调函数
+     * @returns 解除事件
+     * @template K - 预设的监听事件名称
+     * @template C - 回调函数函数上下文
      */
-    once(names: string | string[], callback: (...args: any[]) => void, context?: any): () => this;
+    once<K extends keyof T>(name: K, callback: (...args: Parameters<T[K]>) => ReturnType<T[K]>): () => void;
     /**
      * 解除事件
-     * @param  {string|[string]}  names    事件类型
-     * @param  {function}         callback 事件回调函数
      *
      * 如果 name 不传的话解除对应所有事件
      * 如果 name, callback 不传的话解除所有name的所有事件
+     * @param name - 事件类型
+     * @param callback - 事件回调函数
+     * @template K - 预设的监听事件名称
      */
-    off(names?: string | string[], callback?: (...args: any[]) => void): this;
+    off<K extends keyof T>(name?: K, callback?: (...args: Parameters<T[K]>) => ReturnType<T[K]>): void;
     /**
      * 触发事件
-     * @param  {string|[string]}    name      事件类型
-     * @param  {...any}             data      触发事件的数据
+     * @param name - 事件类型
+     * @param data - 触发事件的数据
+     * @returns canceled 是否被触发取消
+     * @template K - 预设的监听事件名称
      */
-    emit(name: string, ...data: any[]): boolean;
+    emit<K extends keyof T>(name: K, ...data: Parameters<T[K]>): boolean;
 }
-export {};
+export default Subscribe;
+export { Subscribe };
+export type { EventMap as SubscribeEventMap };