Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ emitter.on('foo', (e) => {}); // 'e' has inferred type 'string'
emitter.emit('foo', 42); // Error: Argument of type 'number' is not assignable to parameter of type 'string'. (2345)
```

Event maps can be declared with either `type` or `interface`.

Alternatively, you can use the provided `Emitter` type:

```ts
Expand Down
6 changes: 3 additions & 3 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ export type WildCardEventHandlerList<T = Record<string, unknown>> = Array<
>;

// A map of event types and their corresponding event handlers.
export type EventHandlerMap<Events extends Record<EventType, unknown>> = Map<
export type EventHandlerMap<Events extends object> = Map<
keyof Events | '*',
EventHandlerList<Events[keyof Events]> | WildCardEventHandlerList<Events>
>;

export interface Emitter<Events extends Record<EventType, unknown>> {
export interface Emitter<Events extends object> {
all: EventHandlerMap<Events>;

on<Key extends keyof Events>(type: Key, handler: Handler<Events[Key]>): void;
Expand All @@ -43,7 +43,7 @@ export interface Emitter<Events extends Record<EventType, unknown>> {
* @name mitt
* @returns {Mitt}
*/
export default function mitt<Events extends Record<EventType, unknown>>(
export default function mitt<Events extends object>(
all?: EventHandlerMap<Events>
): Emitter<Events> {
type GenericEventHandler =
Expand Down
17 changes: 17 additions & 0 deletions test/test-types-compilation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,23 @@ const wildcardHandler = (
_event: string | SomeEventData | number | undefined
) => {};

/*
* Check that event maps declared as interfaces work too (#209).
* Interfaces have no implicit index signature, so they did not satisfy
* the old `Record<EventType, unknown>` constraint.
*/
interface InterfaceEvents {
foo: string;
bar?: number;
}

const interfaceEmitter = mitt<InterfaceEvents>();
interfaceEmitter.on('foo', fooHandler);
interfaceEmitter.emit('foo', 'string');
interfaceEmitter.emit('bar', 1);
// @ts-expect-error
interfaceEmitter.emit('foo', 1);

/*
* Check that 'on' args are inferred correctly
*/
Expand Down