Skip to content

Commit 97cdd15

Browse files
committed
1 parent 0f9577d commit 97cdd15

File tree

4 files changed

+10
-9
lines changed

4 files changed

+10
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2556,7 +2556,7 @@ Handle an `event` (TypeScript type).
25562556
```ts
25572557
type KronkEventListener<T extends KronkEvent = KronkEvent> = (
25582558
event: T
2559-
) => undefined
2559+
) => Awaitable<undefined>
25602560
```
25612561
25622562
#### Type Parameters

src/lib/command.mts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ import {
8585
reduceRight
8686
} from '@flex-development/tutils'
8787
import { ok } from 'devlop'
88-
import EventEmitter, { type OnOptions } from 'eventemitter2'
88+
import EventEmitter, { type ListenerFn, type OnOptions } from 'eventemitter2'
8989
import plur from 'plur'
9090

9191
/**
@@ -2544,7 +2544,7 @@ class Command extends Helpable {
25442544
listener: KronkEventListener<T>,
25452545
options?: OnOptions | boolean | undefined
25462546
): undefined {
2547-
return void this.events.on(event, listener, options)
2547+
return void this.events.on(event, listener as ListenerFn, options)
25482548
}
25492549

25502550
/**

src/types/__tests__/kronk-event-listener.spec-d.mts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*/
55

66
import type TestSubject from '#types/kronk-event-listener'
7-
import type { OptionEvent } from '@flex-development/kronk'
7+
import type { Awaitable, OptionEvent } from '@flex-development/kronk'
88

99
describe('unit-d:types/KronkEventListener', () => {
1010
type T = OptionEvent
@@ -17,8 +17,8 @@ describe('unit-d:types/KronkEventListener', () => {
1717
})
1818

1919
describe('returns', () => {
20-
it('should return undefined', () => {
21-
expectTypeOf<Subject>().returns.toEqualTypeOf<undefined>()
20+
it('should return Awaitable<undefined>', () => {
21+
expectTypeOf<Subject>().returns.toEqualTypeOf<Awaitable<undefined>>()
2222
})
2323
})
2424
})

src/types/kronk-event-listener.mts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,23 @@
33
* @module kronk/types/KronkEventListener
44
*/
55

6-
import type { KronkEvent } from '@flex-development/kronk'
6+
import type { Awaitable, KronkEvent } from '@flex-development/kronk'
77

88
/**
99
* Handle an `event`.
1010
*
11+
* @see {@linkcode Awaitable}
1112
* @see {@linkcode KronkEvent}
1213
*
1314
* @template {KronkEvent} [T=KronkEvent]
1415
* The emitted event
1516
*
1617
* @param {KronkEvent} event
1718
* The emitted event
18-
* @return {undefined}
19+
* @return {Awaitable<undefined>}
1920
*/
2021
type KronkEventListener<T extends KronkEvent = KronkEvent> = (
2122
event: T
22-
) => undefined
23+
) => Awaitable<undefined>
2324

2425
export type { KronkEventListener as default }

0 commit comments

Comments
 (0)