docs: document main namespace shortcuts - #5517
Open
nightt5879 wants to merge 1 commit into
Open
Conversation
|
Edgarruiz8585
approved these changes
Jun 27, 2026
| * shortcuts for calling the same methods on this namespace. | ||
| * | ||
| * @example | ||
| * io.sockets.emit("hello"); |
| * io.compress(false).emit("hello"); | ||
| * | ||
| * @param compress - if `true`, compresses the sending data | ||
| * @return a new {@link BroadcastOperator} instance for chaining |
Edgarruiz8585
approved these changes
Jun 27, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #4608
Summary
Servermethods likeio.on(connection),io.use(...), andio.emit(...)are shortcuts for the main namespace.io.socketsnote for the main namespace property.Verification
npx --yes prettier@3.3.2 --check packages/socket.io/lib/index.tsgit diff --check