feat: types新增加导出listeners和anyListener

Author: zhangfisher

docs/zh/guide/use/metadata.md

@@ -26,7 +26,7 @@ emitter.on('x', (message, args) => {
 
 也可以在触发事件时提供额外元数据，该元数据将被合并到事件消息的元数据中。
 
-```typescript
+```typescript twoslash
 import { FastEvent } from 'fastevent';
 
 const emitter = new FastEvent({

docs/zh/guide/use/typescript.md

@@ -251,6 +251,7 @@ emitter.on('click', function (message) {
 
 - `TypedFastEventListener`
 
+根据`FastEvent`泛型参数自动推导出来的监听器类型。
 
 ```ts twoslash
 import { FastEvent,FastEventMessage } from 'fastevent';
@@ -264,17 +265,74 @@ type CustomEvents = {
 const emitter = new FastEvent<CustomEvents>(); 
 
 type ClickListener = typeof emitter.types.listeners['click']
+const listener:ClickListener = (message) => {
+    message.type
+    message.payload
+}
 
 ```
 
 - `TypedFastEventAnyListener`
+
+根据`FastEvent`泛型参数自动推导出来的监听器类型。
+
+```ts twoslash
+import { FastEvent,FastEventMessage } from 'fastevent';
+
+type CustomEvents = {
+    click: { x: number; y: number };
+    mousemove: boolean;
+    scroll: number;
+    focus: string;
+};
+const emitter = new FastEvent<CustomEvents>(); 
+  
+type anyListener = typeof emitter.types.anyListener
+
+const listener:anyListener = (message) => {
+    if(message.type=='click'){
+        message.payload
+    }else if(message.type=='mousemove'){
+        message.payload
+    }else if(message.type=='scroll'){
+        message.payload
+    }
+}
+
+
+```
+
+
 - `FastEventListener`
 
+通用的监听器类型。
 
-## 检索类型
+```ts twoslash
+import { FastEvent,FastEventMessage,FastEventListener } from 'fastevent';
 
-`FastEvent`和`FastEventScope`都提供了`types`对象用于检索事件类型。
+type CustomEvents = {
+    click: { x: number; y: number };
+    mousemove: boolean;
+    scroll: number;
+    focus: string;
+};
+const emitter = new FastEvent<CustomEvents>(); 
+  
+type anyListener = typeof emitter.types.anyListener
+
+const listener:FastEventListener<number> = (message) => {
+    message.type
+    message.payload    
+}
+
+
+```
+
+
+## 检索类型
 
+`FastEvent`和`FastEventScope`支持泛型参数推导，为提供了`types`对象用于检索以下类型。
+ 
 ```ts twoslash
 import { FastEvent } from 'fastevent';
 
@@ -302,6 +360,9 @@ type EventType = typeof emitter.types.events;
 type MetaType = typeof emitter.types.meta;
 type ContextType = typeof emitter.types.context;
 type MessageType = typeof emitter.types.message;
+type ListenersType = typeof emitter.types.listeners;
+type anylistenerType = typeof emitter.types.anyListener;
+
 
 ```
 
@@ -312,3 +373,113 @@ type MessageType = typeof emitter.types.message;
 :::
 
 
+## 全局扩展
+
+`FastEvent`和`FastEventScope`支持全局扩展，用于扩展`FastEvent`和`FastEventScope`的类型。
+
+### FastEvents
+
+扩展全局事件类型。
+
+```ts twoslash
+import { FastEvent } from 'fastevent';
+
+declare module "fastevent" {
+    interface FastEvents {
+        click: { x: number; y: number };
+        mousemove: boolean;
+        scroll: number;
+        focus: string;
+    }
+} 
+const emitter = new FastEvent();
+
+type EventTypes = typeof emitter.types.events
+
+```
+
+
+### FastEventMeta
+
+扩展全局元数据类型。
+
+```ts twoslash
+import { FastEvent } from 'fastevent';
+
+declare module "fastevent" {
+    interface FastEventMeta {
+        x: number;
+        y: number;
+        z?: number;
+    }
+} 
+
+const emitter = new FastEvent();
+
+type MetaType = typeof emitter.types.meta
+
+emitter.onAny((message) => {
+    message.meta.x  // number
+    message.meta.y  // boolean
+    message.meta.z  // string 
+})
+```
+
+
+###  FastEventScopeMeta
+
+扩展全局事件作用域元数据类型。
+
+```ts  twoslash
+import { FastEvent } from 'fastevent';
+
+declare module "fastevent" {
+    interface FastEventMeta {
+        root: number;
+    }
+    interface FastEventScopeMeta {
+        x: number;
+        y: boolean;
+        z?: string;
+    }
+} 
+
+const emitter = new FastEvent();
+
+const scope = emitter.scope("a/b/c");
+
+type MetaType = typeof scope.types.meta
+
+scope.onAny((message) => {
+    message.meta.x  // number
+    message.meta.y  // boolean
+    message.meta.z  // string
+    message.meta.scope // string
+    message.meta.root // number
+})
+
+```
+
+### FastEventMessageExtends
+
+扩展全局消息类型。
+
+```ts  twoslash
+import { FastEvent,FastEventMessage } from 'fastevent';
+
+declare module "fastevent" {
+    interface FastEventMessageExtends {
+        timestamp: number;
+    }
+} 
+
+const message:FastEventMessage = {
+    type: "click",
+    payload: {
+        x: 1,
+        y: 2
+    },
+    timestamp: 1629999999999
+}
+
+```

packages/native/src/__tests__/types/event.types.test.ts

@@ -4,8 +4,14 @@ import type { Equal, Expect, NotAny } from '@type-challenges/utils'
 import { FastEvent } from "../../event"
 import { TypedFastEventMessage, FastEventMeta, PickScopeEvents, ScopeEvents } from "../../types"
 import { FastEventScopeMeta } from "../../scope"
-import { FastEventBus } from "../../eventbus"
-import { E } from "vitest/dist/chunks/environment.d.Dmw5ulng.js"
+// declare module "../.." {
+//     interface FastEvents {
+//         click: { x: number; y: number };
+//         mousemove: boolean;
+//         scroll: number;
+//         focus: string;
+//     }
+// }
 
 describe("类型系统测试", () => {
     describe("作用域事件类型定义", () => {
@@ -28,6 +34,8 @@ describe("类型系统测试", () => {
                     c: 3
                 }>>
             ]
+
+
         })
     })
 
@@ -50,6 +58,7 @@ describe("类型系统测试", () => {
         type CustomMessage = TypedFastEventMessage<CustomEvents, CustomMeta>
         const emitter = new FastEvent<CustomEvents, CustomMeta>()
 
+
         test("on方法应正确推导事件类型和元数据", () => {
             emitter.on("a", (message) => {
                 type cases = [

packages/native/src/event.ts

@@ -44,7 +44,7 @@ export class FastEvent<
     Events extends Record<string, any> = Record<string, any>,
     Meta extends Record<string, any> = Record<string, any>,
     Context = never,
-    // 以上几个泛型是快捷方式
+    // 泛型快捷方式
     AllEvents extends Record<string, any> = Events & FastEvents,
     Types extends keyof AllEvents = Expand<Exclude<keyof (AllEvents), number | symbol>>
 > {
@@ -71,7 +71,8 @@ export class FastEvent<
         meta: undefined as unknown as Expand<FastEventMeta & Meta & Record<string, any>>,
         context: undefined as unknown as Expand<Fallback<Context, typeof this>>,
         message: undefined as unknown as TypedFastEventMessageOptional<AllEvents, Expand<FastEventMeta & Meta & Record<string, any>>>,
-        listeners: undefined as unknown as FastEventListeners<AllEvents, Expand<FastEventMeta & Meta & Record<string, any>>>
+        listeners: undefined as unknown as FastEventListeners<AllEvents, Expand<FastEventMeta & Meta & Record<string, any>>>,
+        anyListener: undefined as unknown as TypedFastEventAnyListener<AllEvents, Expand<FastEventMeta & Meta & Record<string, any>>, Expand<Fallback<Context, typeof this>>>
     }
 
     /**

packages/native/src/scope.ts

@@ -14,7 +14,7 @@ export type FastEventScopeOptions<Meta = Record<string, any>, Context = never> =
     onMessage?: TypedFastEventListener
 }
 
-export type FastEventScopeMeta = {
+export interface FastEventScopeMeta {
     scope: string
 }
 
@@ -32,7 +32,9 @@ export class FastEventScope<
         meta: undefined as unknown as FinalMeta,
         context: undefined as unknown as Fallback<Context, typeof this>,
         message: undefined as unknown as TypedFastEventMessageOptional<Events, FinalMeta>,
-        listeners: undefined as unknown as FastEventListeners<Events, FinalMeta>
+        listeners: undefined as unknown as FastEventListeners<Events, FinalMeta>,
+        anyListener: undefined as unknown as TypedFastEventAnyListener<Events, FinalMeta, Fallback<Context, typeof this>>
+
     }
     prefix: string = ''
     emitter!: FastEvent<Events>

packages/native/src/types.ts

@@ -15,7 +15,7 @@ export type FastEventMessage<P = any, M extends Record<string, any> = Record<str
     type: T
     payload: P
     meta?: M & Partial<FastEventMeta>
-}
+} & FastEventMessageExtends
 
 
 export type TypedFastEventMessage<
@@ -29,7 +29,7 @@ export type TypedFastEventMessage<
             meta: FastEventMeta & M & Record<string, any>
         }
     }[Exclude<keyof Events, number | symbol>]
-) & DeepPartial<FastEventMessageExtends>
+) & FastEventMessageExtends
 
 
 // 用于构建消息时使用，meta是可选的
@@ -44,7 +44,7 @@ export type TypedFastEventMessageOptional<
             meta?: DeepPartial<FastEventMeta & M & Record<string, any>>
         }
     }[Exclude<keyof Events, number | symbol>]
-) & DeepPartial<FastEventMessageExtends>
+) & FastEventMessageExtends
 
 
 
@@ -60,7 +60,7 @@ export type FastEventEmitMessage<
             meta?: DeepPartial<FastEventMeta & M & Record<string, any>>
         }
     }[Exclude<keyof Events, number | symbol>]
-) & DeepPartial<FastEventMessageExtends>
+) & FastEventMessageExtends