SocketData type is not passed down to the Namespace

SocketData type is not passed down to the Namespace when we do io.of().
That results in socket.data being any type:

Example:

const io = new Server<{},{},{},{ username: string }>()

io.on('connection', socket => {
   socket.data /// { username?: string }
})

io.of('/nps').on('connection', socket => {
   socket.data /// any
})

Source code:

socket.io/lib/index.ts

Lines 577 to 582 in 51784d0

    
           public of( 
        
             name: string | RegExp | ParentNspNameMatchFn, 
        
             fn?: ( 
        
               socket: Socket<ListenEvents, EmitEvents, ServerSideEvents, SocketData> 
        
             ) => void 
        
           ): Namespace<ListenEvents, EmitEvents, ServerSideEvents> {

Should be:

of(...): Namespace<ListenEvents, EmitEvents, ServerSideEvents, SocketData>;

Also it would be nice to have RemoteSocket.data type safe. Right now it defaults to any

@OrkhanAlikhanov

@OrkhanAlikhanov that's a great idea! Would you have the time to open a pull request?

@darrachequesne

@darrachequesne When making RemoteSocket.data type safe, should BroadcastOperator<EmitEvents> also change to BroadcastOperator<EmitEvents, SocketData>? I ask because BroadcastOperator.fetchSockets is the method that returns RemoteSocket.

There are 2 options:

Make BroadcastOperator like BroadcastOperator<EmitEvents, SocketData = any>.
Only update fetchSockets method signature:

//from
fetchSockets(): Promise<RemoteSocket<EmitEvents>[]>
// to
fetchSockets<SocketData = any>(): Promise<RemoteSocket<EmitEvents, SocketData>[]>

I think it's better to go with second option. I don't see need to pass SocketData around BroadcastOperator

fix(typings): pass `SocketData` type to custom namespaces (#4233)

fix(types): make `RemoteSocket.data` type safe (#4234)

fix(typings): pass `SocketData` type to custom namespaces (socketio#4233

fix(types): make `RemoteSocket.data` type safe (socketio#4234)

Navigation Menu

Repository navigation

`SocketData` type is not passed down to the `Namespace` #4229

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	public of(
	name: string \| RegExp \| ParentNspNameMatchFn,
	fn?: (
	socket: Socket<ListenEvents, EmitEvents, ServerSideEvents, SocketData>
	) => void
	): Namespace<ListenEvents, EmitEvents, ServerSideEvents> {

SocketData type is not passed down to the Namespace #4229

Description

Activity

OrkhanAlikhanov commented on Jan 1, 2022

darrachequesne commented on Jan 1, 2022

OrkhanAlikhanov commented on Jan 3, 2022

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

`SocketData` type is not passed down to the `Namespace` #4229