Skip to content

docs: warn about empty-object UwsSocketImpl.data cast at class level (#191) #200

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

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

docs: warn about empty-object UwsSocketImpl.data cast at class level (#191) #200

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
11 changes: 9 additions & 2 deletions src/websocket/core/socket.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,15 @@ import { RoomManager } from '../rooms';
import { BroadcastOperator } from './broadcast-operator';

/**
* Socket wrapper that provides a Socket.IO-like API over native uWebSockets.js
* This class wraps the native uWS.WebSocket and adds convenient methods
* Socket wrapper that provides a Socket.IO-like API over native uWebSockets.js.
* This class wraps the native uWS.WebSocket and adds convenient methods.
*
* IMPORTANT: `data` is initialized as an empty object cast to `TData`. The cast
* is safe for object types without required fields (the common case) but is
* unsafe when `TData` is a primitive type or has required properties: reading
* `socket.data` before assigning to it will surface a partially-typed value.
* Always assign `socket.data` before reading it in those cases.
*
* @template TData - Type of custom data attached to the socket
* @template TEmitData - Type of data that can be emitted
*/
Expand Down
Loading