docs: fix incorrect content for emit method in event api

alibaba · Mar 9, 2023 · 53ada7b · 53ada7b
1 parent 88961aa
commit 53ada7b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/docs/docs/api/event.md b/docs/docs/api/event.md
@@ -43,12 +43,13 @@ off(event: string, listener: (...args: any[]) => void): void;
 
 ```typescript
 /**
- * 取消监听事件
- * cancel a monitor from a event
+ * 触发事件
+ * emit a message for a event
  * @param event 事件名称
- * @param listener 事件回调
+ * @param args 事件参数
+ * @returns
  */
-off(event: string, listener: (...args: any[]) => void): void;
+emit(event: string, ...args: any[]): void;
 ```
 
 ## 使用示例

diff --git a/packages/types/src/shell/api/event.ts b/packages/types/src/shell/api/event.ts
@@ -21,7 +21,7 @@ export interface IPublicApiEvent {
 
   /**
    * 触发事件
-   * emit a message fot a event
+   * emit a message for a event
    * @param event 事件名称
    * @param args 事件参数
    * @returns