Appearance
createWebSocket 创建 WebSocket
function createWebSocket(url: string): WebSocket
根据传入地址创建并返回原生 WebSocket 实例。
参数
| 参数名 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| url | WebSocket 服务地址 | string | 必填 |
返回值
| 返回值 | 说明 | 类型 |
|---|---|---|
| socket | 新创建的 WebSocket 实例 | WebSocket |
示例
基础用法
typescript
import { createWebSocket } from '@mingto/tools'
const socket = createWebSocket('wss://example.com/ws')
socket.onopen = () => {
socket.send('hello')
}
socket.onmessage = (event) => {
console.log(event.data)
}关闭连接
typescript
socket.close()注意事项
- 该函数不会检查浏览器是否支持 WebSocket;如需兼容判断,请先使用
isWebSocketSupported。 - URL 格式错误或连接失败会由原生 WebSocket 抛出或触发错误事件。