one-server-ws v0.0.3

It's a toolkit for nodejs WebSocket.

Functions

interface WebSocketConfig {
  port?:number; 
  https?:{
    key:string; 
    cert:string;
  },
  auth?: { 
    secret?:string; // TOKEN的加密密钥
  }
}

/**
 * 建立HTTP(s)/WS(S)连接, 进行Websocket通讯
 * 支持JWT身份验证
 * 客户端Demo: 
    const socket = new WebSocket('https://localhost:3030', {
      secure: true, // 指定使用安全的 HTTPS 协议
      rejectUnauthorized: false, // 如果不验证证书，设置为 true
      headers: { Authorization: token }
    });
 */
class WSSocket {
  constructor(filename:string);
  constructor(options:WebSocketConfig);
  handle(callback:(msg: Buffer | ArrayBuffer | Buffer[], socket:WebSocket)=>void): this;
  start(callback:(msg:string)=>void): this;
}