# Interface: ConnectSocketParams ‹Err›
• ConnectSocketParams‹Err›()
# Type parameters:
▪ Err: MogsRes
# Type parameters
▪ Err: MogsRes
# Properties
# Optional header
• header? : Record‹string, unknown›
HTTP Header，Header 中不能设置 Referer
Returns: Record‹string, unknown›
# Optional perMessageDeflate
• perMessageDeflate? : boolean
是否开启压缩扩展
default false
Returns: boolean
# Optional protocols
• protocols? : string[]
子协议数组
Returns: string[]
# Optional tcpNoDelay
• tcpNoDelay? : boolean
建立 TCP 连接的时候的 TCP_NODELAY 设置
default false
Returns: boolean
# Optional timeout
• timeout? : number
超时时间，单位为毫秒
Returns: number
# url
• url: string
开发者服务器 wss 接口地址
Returns: string
# Methods
# Optional complete
▸ complete(res: ConnectSocketRes | Err): void
Inherited from MogsParams.complete
接口调用结束的回调函数（调用成功、失败都会执行）
# 参数:
| 属性 | 类型 |
|---|---|
res | ConnectSocketRes | Err |
# 返回值:
void
# Optional fail
▸ fail(err: Err): void
Inherited from MogsParams.fail
接口调用失败的回调函数
# 参数:
| 属性 | 类型 |
|---|---|
err | Err |
# 返回值:
void
# Optional success
▸ success(res: ConnectSocketRes): void
Inherited from MogsParams.success
接口调用成功的回调函数
# 参数:
| 属性 | 类型 |
|---|---|
res | ConnectSocketRes |
ConnectSocketRes
| 属性 | 类型 | 描述 |
|---|---|---|
errMsg | string | API 调用成功/失败的消息 |
# 返回值:
void