developit / developit/mitt

How to declare type of event parameter when listen for event

Open
#188 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
11.9k
Forks
488
PR merge metrics
No merged PRs in 30d

Description

Hello,

I am using mitt 3.0.1 for my Nuxt app (nuxt 3.6.5). I use event-bus to emit/listen for the whole app:

File plugins/event-bus.ts
```
import mitt from 'mitt';

export default defineNuxtPlugin(() => {
const emitter = mitt();

return {
provide: {
event: emitter.emit, // Will emit an event
listen: emitter.on, // Will register a listener for an event
},
};
});

```
I am currently not able to declare event when I listen for event in my components. I have to use type "any" but this break out type safety rules.
```
$listen('component:display', (event: any) => {
// here the param I want to declare a specific type rather than type "any"
// like event: {id?: string; value?: string}
});
```

I already tried assigned a sepecific type but it throw error:
```
$listen('component:display', (event:{id?: string; value?: string}) => {
//
});

ERROR: No overload matches this call.
Overload 1 of 2, '(type: "*", handler: WildcardHandler>): void', gave the following error.
Overload 2 of 2, '(type: "component:display", handler: Handler): void', gave the following error.ts(2769)
```

It's now allowed to use flag @ts-ignore in my app so I don't know how to solve this now.
I search on document but it seems no mention about this so I hope to receive any advice on this.
Thank you so much.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.