@types/socket.io-client 是用于在 TypeScript 代码中使用 socket.io-client 库的类型定义文件，可以提供类型检查和代码自动补全的功能。它可以为前端开发人员提供更可读、更稳定的代码。在本篇文章中，我们将深入讲解如何使用这个 NPM 包。
安装
在开始使用该包前，需要先安装 socket.io-client 和 @types/socket.io-client 。在终端中输入以下命令来完成安装：
npm install socket.io-client @types/socket.io-client
示例代码
以下是一个基本的客户端连接到 socket.io 服务器的 TypeScript 代码：
-- -------------------- ---- ------- ------ -- ---- ------------------- ----- ------ - ------------------------------------ -------------------- -- -- - ---------------------- -- --------------- --- -------------------- --------- ------- -- - --------------------- -------- ------------- --- ---------------------- ------ ----------
API 使用指南
io
io() 用于建立 websocket 连接，返回一个 Socket 对象。
import io from 'socket.io-client';
const socket = io('http://localhost:3000');Socket
Socket 是用于与服务器进行通信的主要接口。
on(eventName: string, callback: Function)
监听服务器发送的消息。
socket.on('message', (message: string) => {
console.log(`Received message: ${message}`);
});emit(eventName: string[, ...args][, ack])
向服务器发送消息。
socket.emit('message', 'Hello server!');once(eventName: string, callback: Function)
监听一次服务器发送的消息。
socket.once('message', (message: string) => {
console.log(`Received message: ${message}`);
});off(eventName: string[, callback])
停止监听服务器发送的消息。
socket.off('message', callback);disconnect()
关闭与服务器的连接。
socket.disconnect();
总结
@types/socket.io-client 可以为前端开发人员提供更良好的开发体验，使用起来也非常简单。如果你不习惯使用 TypeScript 进行开发，也可以直接使用 socket.io-client 库进行开发。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/93200