Skip to content

Commit 53ada7b

Browse files
kit101JackLian
authored andcommitted
docs: fix incorrect content for emit method in event api
1 parent 88961aa commit 53ada7b

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

docs/docs/api/event.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,13 @@ off(event: string, listener: (...args: any[]) => void): void;
4343

4444
```typescript
4545
/**
46-
* 取消监听事件
47-
* cancel a monitor from a event
46+
* 触发事件
47+
* emit a message for a event
4848
* @param event 事件名称
49-
* @param listener 事件回调
49+
* @param args 事件参数
50+
* @returns
5051
*/
51-
off(event: string, listener: (...args: any[]) => void): void;
52+
emit(event: string, ...args: any[]): void;
5253
```
5354

5455
## 使用示例

packages/types/src/shell/api/event.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export interface IPublicApiEvent {
2121

2222
/**
2323
* 触发事件
24-
* emit a message fot a event
24+
* emit a message for a event
2525
* @param event 事件名称
2626
* @param args 事件参数
2727
* @returns

0 commit comments

Comments
 (0)