How to use socket.IO client type definitions for Typescript?

Question

I have installed the Typescript definitions for a SocketIO client using

npm install @types/socket.io-client

But in VS Code I still get type errors:

let socket: SocketIOClientStatic = io()

Type 'Socket' is missing the following properties from type 'SocketIOClientStatic': protocol, Socket, Manager, managersts(2739)

All these properties are not mentioned as options in intellisense, or in he socketIO docs... they shouldn't be needed when creating an io()

How can I use Typescript with the SocketIO client?

Oblosys · Accepted Answer · 2019-07-24 20:39:02Z

17

The io function has return type SocketIOClient.Socket and not SocketIOClientStatic. If you use that type, or leave out the signature altogether, it works as expected:

import io from 'socket.io-client';

const socket: SocketIOClient.Socket = io('http://localhost');
const anotherSocket = io('http://localhost');

answered Jul 24, 2019 at 20:39

Oblosys

15.2k3 gold badges33 silver badges41 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Viktor Tarnavskyi · Accepted Answer · 2021-08-20 12:42:04Z

7

On client version 4.x

import { io, Socket } from "socket.io-client";

answered Aug 20, 2021 at 12:42

Viktor Tarnavskyi

6416 silver badges7 bronze badges

Comments

Niklas · Accepted Answer · 2020-12-27 20:30:40Z

0

I'd like to extend the answer of Oblosys:

If the esModuleInterop flag is active and you get an error message like

This module is declared with using 'export =', and can only be used with a default import when using the 'esModuleInterop' flag.

then do the import with the as-Syntax:

import * as io from 'socket.io-client';

const socket: SocketIOClient.Socket = io('http://localhost');

answered Dec 27, 2020 at 20:30

Niklas

4577 silver badges17 bronze badges

Collectives™ on Stack Overflow

How to use socket.IO client type definitions for Typescript?

3 Answers 3

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related