Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Syntax:
```ts
interface ServerToClientEvents {
"my-event": (a: number, b: string, c: number[]) => void;
}
interface ClientToServerEvents {
hello: (message: string) => void;
}
const socket: Socket<ServerToClientEvents, ClientToServerEvents> = io();
socket.emit("hello", "world");
socket.on("my-event", (a, b, c) => {
// ...
});
```
The events are not typed by default (inferred as any), so this change
is backward compatible.
Related: socketio/socket.io#3742- Loading branch information
1 parent
78ec5a6
commit 5902365
Showing
7 changed files
with
1,581 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| import Emitter = require("component-emitter"); | ||
|
|
||
| /** | ||
| * An events map is an interface that maps event names to their value, which | ||
| * represents the type of the `on` listener. | ||
| */ | ||
| export interface EventsMap { | ||
| [event: string]: any; | ||
| } | ||
|
|
||
| /** | ||
| * The default events map, used if no EventsMap is given. Using this EventsMap | ||
| * is equivalent to accepting all event names, and any data. | ||
| */ | ||
| export interface DefaultEventsMap { | ||
| [event: string]: (...args: any[]) => void; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a union type containing all the keys of an event map. | ||
| */ | ||
| export type EventNames<Map extends EventsMap> = keyof Map & (string | symbol); | ||
|
|
||
| /** The tuple type representing the parameters of an event listener */ | ||
| export type EventParams< | ||
| Map extends EventsMap, | ||
| Ev extends EventNames<Map> | ||
| > = Parameters<Map[Ev]>; | ||
|
|
||
| /** | ||
| * The event names that are either in ReservedEvents or in UserEvents | ||
| */ | ||
| export type ReservedOrUserEventNames< | ||
| ReservedEventsMap extends EventsMap, | ||
| UserEvents extends EventsMap | ||
| > = EventNames<ReservedEventsMap> | EventNames<UserEvents>; | ||
|
|
||
| /** | ||
| * Type of a listener of a user event or a reserved event. If `Ev` is in | ||
| * `ReservedEvents`, the reserved event listener is returned. | ||
| */ | ||
| export type ReservedOrUserListener< | ||
| ReservedEvents extends EventsMap, | ||
| UserEvents extends EventsMap, | ||
| Ev extends ReservedOrUserEventNames<ReservedEvents, UserEvents> | ||
| > = Ev extends EventNames<ReservedEvents> | ||
| ? ReservedEvents[Ev] | ||
| : Ev extends EventNames<UserEvents> | ||
| ? UserEvents[Ev] | ||
| : never; | ||
|
|
||
| /** | ||
| * Strictly typed version of an `EventEmitter`. A `TypedEventEmitter` takes type | ||
| * parameters for mappings of event names to event data types, and strictly | ||
| * types method calls to the `EventEmitter` according to these event maps. | ||
| * | ||
| * @typeParam ListenEvents - `EventsMap` of user-defined events that can be | ||
| * listened to with `on` or `once` | ||
| * @typeParam EmitEvents - `EventsMap` of user-defined events that can be | ||
| * emitted with `emit` | ||
| * @typeParam ReservedEvents - `EventsMap` of reserved events, that can be | ||
| * emitted by socket.io with `emitReserved`, and can be listened to with | ||
| * `listen`. | ||
| */ | ||
| export abstract class StrictEventEmitter< | ||
| ListenEvents extends EventsMap, | ||
| EmitEvents extends EventsMap, | ||
| ReservedEvents extends EventsMap = {} | ||
| > extends Emitter { | ||
| /** | ||
| * Adds the `listener` function as an event listener for `ev`. | ||
| * | ||
| * @param ev Name of the event | ||
| * @param listener Callback function | ||
| */ | ||
| on<Ev extends ReservedOrUserEventNames<ReservedEvents, ListenEvents>>( | ||
| ev: Ev, | ||
| listener: ReservedOrUserListener<ReservedEvents, ListenEvents, Ev> | ||
| ): this { | ||
| super.on(ev as string, listener); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Adds a one-time `listener` function as an event listener for `ev`. | ||
| * | ||
| * @param ev Name of the event | ||
| * @param listener Callback function | ||
| */ | ||
| once<Ev extends ReservedOrUserEventNames<ReservedEvents, ListenEvents>>( | ||
| ev: Ev, | ||
| listener: ReservedOrUserListener<ReservedEvents, ListenEvents, Ev> | ||
| ): this { | ||
| super.once(ev as string, listener); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Emits an event. | ||
| * | ||
| * @param ev Name of the event | ||
| * @param args Values to send to listeners of this event | ||
| */ | ||
| emit<Ev extends EventNames<EmitEvents>>( | ||
| ev: Ev, | ||
| ...args: EventParams<EmitEvents, Ev> | ||
| ): this { | ||
| super.emit(ev as string, ...args); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Emits a reserved event. | ||
| * | ||
| * This method is `protected`, so that only a class extending | ||
| * `StrictEventEmitter` can emit its own reserved events. | ||
| * | ||
| * @param ev Reserved event name | ||
| * @param args Arguments to emit along with the event | ||
| */ | ||
| protected emitReserved<Ev extends EventNames<ReservedEvents>>( | ||
| ev: Ev, | ||
| ...args: EventParams<ReservedEvents, Ev> | ||
| ): this { | ||
| super.emit(ev as string, ...args); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the listeners listening to an event. | ||
| * | ||
| * @param event Event name | ||
| * @returns Array of listeners subscribed to `event` | ||
| */ | ||
| listeners<Ev extends ReservedOrUserEventNames<ReservedEvents, ListenEvents>>( | ||
| event: Ev | ||
| ): ReservedOrUserListener<ReservedEvents, ListenEvents, Ev>[] { | ||
| return super.listeners(event as string) as ReservedOrUserListener< | ||
| ReservedEvents, | ||
| ListenEvents, | ||
| Ev | ||
| >[]; | ||
| } | ||
| } |
Oops, something went wrong.