Skip to content

Commit f831577

Browse files
committed
feat: update readme
1 parent 5dbda75 commit f831577

File tree

2 files changed

+26
-7
lines changed

2 files changed

+26
-7
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@
1212
1313
```html
1414
使用 UMD 格式
15-
<script src="https://www.unpkg.com/@skillnull/[email protected].7/dist/WebEESocket.js"></script>
15+
<script src="https://www.unpkg.com/@skillnull/[email protected].8/dist/WebEESocket.js"></script>
1616
# or
17-
<script src="https://cdn.jsdelivr.net/npm/@skillnull/[email protected].7/dist/WebEESocket.js"></script>
17+
<script src="https://cdn.jsdelivr.net/npm/@skillnull/[email protected].8/dist/WebEESocket.js"></script>
1818

1919
使用 ES 格式
20-
<script src="https://www.unpkg.com/@skillnull/[email protected].7/dist/WebEESocket.es.js"></script>
20+
<script src="https://www.unpkg.com/@skillnull/[email protected].8/dist/WebEESocket.es.js"></script>
2121
# or
22-
<script src="https://cdn.jsdelivr.net/npm/@skillnull/[email protected].7/dist/WebEESocket.es.js"></script>
22+
<script src="https://cdn.jsdelivr.net/npm/@skillnull/[email protected].8/dist/WebEESocket.es.js"></script>
2323
```
2424

2525

@@ -38,8 +38,27 @@ npm install @skillnull/webeesocket
3838
// 使用 CDN 引用时,无需 import
3939
import { WEBSOCKET } from '@skillnull/webeesocket'
4040

41-
this.WEBSOCKET = new WEBSOCKET({
42-
env: 'development'
41+
/**
42+
* @params: {
43+
* url: <String> 服务器连接地址
44+
* auth: <Any> 服务器认证信息
45+
* heartbeat?: <Any> 心跳握手内容
46+
* heartbeat_time?: <Any> 心跳握手间隔,默认3000ms,heartbeat 传值此项才会生效
47+
* protocol?: <String | String[]> 协议
48+
* reconnect_step?: <Number> 重连间隔,不传默认 1000,传 -1 表示不重连
49+
* }
50+
*/
51+
this.WEBSOCKET = new WEBSOCKET({
52+
url: "your socket server url",
53+
auth: {
54+
// server need auth info
55+
},
56+
heartbeat: {
57+
// heartbeat need info
58+
},
59+
heartbeat_time: 3000,
60+
protocol: "protocol for websocket",
61+
reconnect_step: 1000
4362
})
4463

4564
/**

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"version": "0.0.7",
2+
"version": "0.0.8",
33
"name": "@skillnull/webeesocket",
44
"description": "通过事件驱动机制 EventEmitter 对 Websocket 和微信 connectSocket 进行集成封装",
55
"main": "dist/WebEESocket",

0 commit comments

Comments
 (0)