Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note about strictly typed events in socket.io 4.0.0 #18

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add note about strictly typed events in socket.io 4.0.0 #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ clientSocket.on(/* only events that are sent from the server are allowed */, ...
clientSocket.emit(/* only events that are emitted from the client are allowed */, ...)
```

**Note**: socket.io has support for strictly typing events [since version 4.0.0](https://socket.io/docs/v4/migrating-from-3-x-to-4-0/#Typed-events). If you want to type socket.io events, consider using socket.io 4.0.0 (or newer versions) instead of using `strict-event-emitter-types`.

##### Usage with Subclasses

To subclass an EventEmitter you need to cast the base EventEmitter to the strict EventEmitter before extending:
Expand Down