feat: connect options (#28)

Author: ddiu8081

README.md

@@ -41,6 +41,21 @@ instance.close()
 
 > 需传入房间的长id。短id需转为长id才能接收到消息。(https://github.com/ddiu8081/blive-message-listener/issues/19)
 
+## Options
+
+你可以向 `startListen` 传入第三个参数 `options` 来手动配置连接选项。
+
+```ts
+interface MessageListenerOptions {
+  /**
+   * tiny-bilibili-ws 连接选项
+   *
+   * @see https://github.com/starknt/tiny-bilibili-ws
+   */
+  ws?: WSOptions | TCPOptions
+}
+```
+
 ## Handlers & Type Definitions
 
 ### Common

example/browser/src.ts

@@ -13,11 +13,11 @@ const handler: MsgHandler = {
     logDom!.innerHTML += `${JSON.stringify(msg.body)}<br>`
   },
   raw: {
-    'INTERACT_WORD': (msg) => {
+    INTERACT_WORD: (msg) => {
       console.log(msg)
       logDom!.innerHTML += `${JSON.stringify(msg)}<br>`
     },
-  }
+  },
 }
 
 startListen(652581, handler)

example/node/node.ts

@@ -8,10 +8,10 @@ const handler: MsgHandler = {
     console.log(msg)
   },
   raw: {
-    'INTERACT_WORD': (msg) => {
+    INTERACT_WORD: (msg) => {
       console.log(msg)
     },
-  }
+  },
 }
 
 startListen(652581, handler)

package.json

@@ -40,10 +40,10 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "tiny-bilibili-ws": "^0.1.8"
+    "tiny-bilibili-ws": "^0.1.9"
   },
   "devDependencies": {
     "tsup": "^6.7.0",
-    "typescript": "^5.1.3"
+    "typescript": "^5.1.6"
   }
 }

pnpm-lock.yaml

@@ -1,10 +1,19 @@
 import { KeepLiveWS } from 'tiny-bilibili-ws/browser'
+import { listenAll, type MsgHandler } from './listener'
 import type { MessageListener } from '.'
+import type { WSOptions } from 'tiny-bilibili-ws'
 
-import { listenAll, type MsgHandler } from './listener'
+interface MessageListenerWSOptions {
+  /**
+   * tiny-bilibili-ws 连接选项
+   *
+   * @see https://github.com/starknt/tiny-bilibili-ws
+   */
+  ws?: WSOptions
+}
 
-export const startListen = (roomId: number, handler: MsgHandler) => {
-  const live = new KeepLiveWS(roomId)
+export const startListen = (roomId: number, handler: MsgHandler, options?: MessageListenerWSOptions) => {
+  const live = new KeepLiveWS(roomId, options?.ws)
 
   listenAll(live, roomId, handler)
 

src/browser.ts

@@ -1,6 +1,6 @@
 import { KeepLiveTCP } from 'tiny-bilibili-ws'
-
 import { listenAll, type MsgHandler } from './listener'
+import type { TCPOptions } from 'tiny-bilibili-ws'
 
 export interface MessageListener {
   /** 直播间房间号 */
@@ -11,8 +11,17 @@ export interface MessageListener {
   getAttention: () => Promise<number>
 }
 
-export const startListen = (roomId: number, handler: MsgHandler) => {
-  const live = new KeepLiveTCP(roomId)
+interface MessageListenerTCPOptions {
+  /**
+   * tiny-bilibili-ws 连接选项
+   *
+   * @see https://github.com/starknt/tiny-bilibili-ws
+   */
+  ws?: TCPOptions
+}
+
+export const startListen = (roomId: number, handler: MsgHandler, options?: MessageListenerTCPOptions) => {
+  const live = new KeepLiveTCP(roomId, options?.ws)
 
   listenAll(live, roomId, handler)