utils-uniapp 1.2.9 → 1.2.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,4 +1,28 @@
|
|
|
1
1
|
// WebSocketClient.d.ts
|
|
2
|
+
export type WebSocketFailInfo =
|
|
3
|
+
| {
|
|
4
|
+
type: 'connectError';
|
|
5
|
+
url: string;
|
|
6
|
+
willRetry: boolean;
|
|
7
|
+
event: UniApp.GeneralCallbackResult;
|
|
8
|
+
}
|
|
9
|
+
| {
|
|
10
|
+
type: 'maxReconnect';
|
|
11
|
+
url: string;
|
|
12
|
+
willRetry: false;
|
|
13
|
+
maxReconnect: number;
|
|
14
|
+
};
|
|
15
|
+
export declare interface WebSocketClientEventMap {
|
|
16
|
+
open: (res: UniApp.OnSocketOpenCallbackResult) => void;
|
|
17
|
+
reconnect: (res: UniApp.OnSocketOpenCallbackResult) => void;
|
|
18
|
+
message: (res: UniApp.OnSocketMessageCallbackResult) => void;
|
|
19
|
+
close: (res: UniApp.OnSocketCloseCallbackResult) => void;
|
|
20
|
+
error: (err: UniApp.GeneralCallbackResult) => void;
|
|
21
|
+
fail: (info: WebSocketFailInfo) => void;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export declare type WebSocketEventName = keyof WebSocketClientEventMap;
|
|
25
|
+
export declare type WebSocketEventHandler<K extends WebSocketEventName> = WebSocketClientEventMap[K];
|
|
2
26
|
export declare class WebSocketClient {
|
|
3
27
|
/**
|
|
4
28
|
* @param url websocket地址
|
|
@@ -24,22 +48,18 @@ export declare class WebSocketClient {
|
|
|
24
48
|
* @param event 事件名 open | message | close | error
|
|
25
49
|
* @param fn 回调函数
|
|
26
50
|
*/
|
|
27
|
-
on(event:
|
|
28
|
-
on(event: 'message', fn: (res: UniApp.OnSocketMessageCallbackResult) => void): this;
|
|
29
|
-
on(event: 'close', fn: (res: UniApp.OnSocketCloseCallbackResult) => void): this;
|
|
30
|
-
on(event: 'error', fn: (err: UniApp.GeneralCallbackResult) => void): this;
|
|
31
|
-
|
|
51
|
+
on<K extends WebSocketEventName>(event: K, fn: WebSocketEventHandler<K>): this;
|
|
32
52
|
/**
|
|
33
53
|
* 移除事件监听
|
|
34
54
|
* @param event 事件名
|
|
35
55
|
* @param fn 回调函数
|
|
36
56
|
*/
|
|
37
|
-
off(event:
|
|
57
|
+
off<K extends WebSocketEventName>(event: K, fn: WebSocketEventHandler<K>): this;
|
|
38
58
|
|
|
39
59
|
/**
|
|
40
60
|
* 内部触发事件（外部一般不用）
|
|
41
61
|
*/
|
|
42
|
-
emit(event:
|
|
62
|
+
emit(event: WebSocketEventName, ...args: any[]): void;
|
|
43
63
|
|
|
44
64
|
/**
|
|
45
65
|
* 建立连接
|
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const
|
|
1
|
+
"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const c=require("../_rollupPluginBabelHelpers-63255c86.js");var u=function(){function i(o){var e,n=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{};c._classCallCheck(this,i),this.url=o,this.reconnectDelay=n.reconnectDelay||1e3,this.heartbeatInterval=n.heartbeatInterval||3e4,this.heartbeatTimeout=n.heartbeatTimeout||1e4,this.heartbeatMsg=n.heartbeatMsg||"ping",this.maxReconnect=(e=n.maxReconnect)!==null&&e!==void 0?e:-1,this.socketTask=null,this.isConnected=!1,this.heartbeatTimer=null,this.heartbeatTimeoutTimer=null,this.reconnectTimer=null,this.reconnectCount=0,this.manualClose=!1,this.events={open:[],message:[],close:[],error:[],reconnect:[],fail:[]}}return c._createClass(i,[{key:"on",value:function(e,n){return this.events[e]&&this.events[e].push(n),this}},{key:"off",value:function(e,n){if(!this.events[e])return this;var s=this.events[e].indexOf(n);return s>-1&&this.events[e].splice(s,1),this}},{key:"emit",value:function(e){for(var n=arguments.length,s=new Array(n>1?n-1:0),t=1;t<n;t++)s[t-1]=arguments[t];this.events[e]&&this.events[e].forEach(function(a){try{a.apply(void 0,s)}catch(r){console.error("[".concat(e,"] callback error:"),r)}})}},{key:"connect",value:function(){var e=this;if(this.socketTask){var n=this.socketTask;this.socketTask=null,n.close({code:1e3,reason:"reconnect"})}this.manualClose=!1,this.socketTask=uni.connectSocket({url:this.url,success:function(){},complete:function(){}});var s=this.socketTask;return s.onOpen(function(t){var a=e.reconnectCount>0;e.isConnected=!0,e.reconnectCount=0,console.log("Connection established"),e.emit("open",t),a&&(console.log("Reconnected successfully"),e.emit("reconnect",t)),e.startHeartbeat()}),s.onMessage(function(t){e.resetHeartbeatTimeout(),e.emit("message",t)}),s.onClose(function(t){e.isConnected=!1,e.stopHeartbeat(),s===e.socketTask&&(console.log("Connection closed",t),e.emit("close",t),!e.manualClose&&e.reconnect())}),s.onError(function(t){if(console.error("WebSocket error: ",t),e.emit("error",t),s===e.socketTask){if(e.isConnected=!1,e.stopHeartbeat(),!e.manualClose){var a=e.maxReconnect===-1||e.reconnectCount<e.maxReconnect;e.emit("fail",{type:"connectError",url:e.url,willRetry:a,event:t})}try{s.close({code:1e3,reason:"error"})}catch(r){}e.manualClose||e.reconnect()}}),this}},{key:"send",value:function(e){return this.isConnected&&this.socketTask?this.socketTask.send({data:e}):console.error("WebSocket is not connected"),this}},{key:"startHeartbeat",value:function(){var e=this;this.stopHeartbeat(),this.heartbeatTimer=setInterval(function(){e.isConnected&&(e.send(e.heartbeatMsg),e.startHeartbeatTimeout())},this.heartbeatInterval)}},{key:"stopHeartbeat",value:function(){this.heartbeatTimer&&(clearInterval(this.heartbeatTimer),this.heartbeatTimer=null),this.clearHeartbeatTimeout()}},{key:"startHeartbeatTimeout",value:function(){var e=this;this.clearHeartbeatTimeout(),this.heartbeatTimeoutTimer=setTimeout(function(){console.warn("Heartbeat timeout, close socket"),e.socketTask&&e.socketTask.close()},this.heartbeatTimeout)}},{key:"resetHeartbeatTimeout",value:function(){this.clearHeartbeatTimeout()}},{key:"clearHeartbeatTimeout",value:function(){this.heartbeatTimeoutTimer&&(clearTimeout(this.heartbeatTimeoutTimer),this.heartbeatTimeoutTimer=null)}},{key:"reconnect",value:function(){var e=this;if(!(this.isConnected||this.reconnectTimer)){if(this.maxReconnect!==-1&&this.reconnectCount>=this.maxReconnect){console.log("Reach max reconnect count, stop reconnect"),this.emit("fail",{type:"maxReconnect",maxReconnect:this.maxReconnect,url:this.url});return}this.reconnectCount+=1,console.log("Reconnecting in ".concat(this.reconnectDelay/1e3," seconds... count:").concat(this.reconnectCount)),this.reconnectTimer=setTimeout(function(){e.reconnectTimer=null,e.connect()},this.reconnectDelay)}}},{key:"close",value:function(){var e=arguments.length>0&&arguments[0]!==void 0?arguments[0]:1e3,n=arguments.length>1&&arguments[1]!==void 0?arguments[1]:"";this.manualClose=!0,this.stopHeartbeat(),this.reconnectTimer&&(clearTimeout(this.reconnectTimer),this.reconnectTimer=null),this.reconnectCount=0,this.socketTask&&this.socketTask.close({code:e,reason:n})}}])}();exports.WebSocketClient=u;exports.default=u;
|