feat(createEventHook): allow awaiting on trigger (#2824)

Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>

Author: Akryum

packages/shared/createEventHook/index.test.ts

@@ -55,6 +55,31 @@ describe('createEventHook', () => {
     expect(listener).toHaveBeenCalledTimes(2)
   })
 
+  it('should await trigger', async () => {
+    let message = ''
+
+    const myFunction = () => {
+      const resultEvent = createEventHook<string>()
+      const exec = () => resultEvent.trigger('Hello World')
+      return {
+        exec,
+        onResult: resultEvent.on,
+      }
+    }
+
+    const { exec, onResult } = myFunction()
+    onResult(result => new Promise<number>((resolve) => {
+      setTimeout(() => {
+        message = result
+        resolve(2)
+      }, 100)
+    }))
+    const result = await exec()
+
+    expect(message).toBe('Hello World')
+    expect(result).toEqual([2])
+  })
+
   it('the same listener should fire only once', () => {
     const listener = vitest.fn()
     const { on, trigger, off } = createEventHook<string>()

packages/shared/createEventHook/index.ts

@@ -6,7 +6,7 @@ import { tryOnScopeDispose } from '../tryOnScopeDispose'
 
 export type EventHookOn<T = any> = (fn: (param: T) => void) => { off: () => void }
 export type EventHookOff<T = any> = (fn: (param: T) => void) => void
-export type EventHookTrigger<T = any> = (param: T) => void
+export type EventHookTrigger<T = any> = (param: T) => Promise<unknown[]>
 
 export interface EventHook<T = any> {
   on: EventHookOn<T>
@@ -38,7 +38,7 @@ export function createEventHook<T = any>(): EventHook<T> {
   }
 
   const trigger = (param: T) => {
-    fns.forEach(fn => fn(param))
+    return Promise.all(fns.map(fn => fn(param)))
   }
 
   return {