docs(websockets): add JWT connection authentication guide#3463
Open
faizkhairi wants to merge 2 commits into
Open
docs(websockets): add JWT connection authentication guide#3463faizkhairi wants to merge 2 commits into
faizkhairi wants to merge 2 commits into
Conversation
Document validating JWT credentials in handleConnection for socket.io handshakes, including client auth example and room assignment pattern.
Required when guards.md uses named filename code blocks; fixes Netlify deploy preview build failure on PR nestjs#3463.
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
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
The WebSockets Guards page documents
@UseGuards()on@SubscribeMessage()handlers only. It does not explain how to authenticate clients during the initial Socket.IOhandleConnection()handshake.Related discussion: nestjs/nest#882
Issue Number: N/A
What is the new behavior?
Adds an Authenticating connections section to
content/websockets/guards.mdcovering:handshake.author theAuthorizationheaderhandleConnection()socket.io-clientexampleDoes this PR introduce a breaking change?
Other information
Verified locally:
Result: docs generated successfully (includes updated
websockets/guardspage).Examples follow existing
@@filename/@@switchconventions used elsewhere in the docs repo.