# one-server-ws

> > It's a toolkit for nodejs WebSocket.

Latest version **0.0.3** (published 2023-11-01) · 0 weekly downloads

## Install

```sh
npm install one-server-ws
pnpm add one-server-ws
yarn add one-server-ws
bun add one-server-ws
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2023-11-01 |
| First published | 2023-10-13 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 11.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | geo.pan |

## Links

- npm: https://www.npmjs.com/package/one-server-ws
- npm.io page: https://npm.io/package/one-server-ws

## Dependencies (3)

- [ws](https://npm.io/package/ws.md) ^8.14.2
- [express](https://npm.io/package/express.md) ^4.18.2
- [one-server-tools](https://npm.io/package/one-server-tools.md) ^0.0.3

## Recent versions

- 0.0.3 (latest) — 2023-11-01
- 0.0.2 — 2023-10-17
- 0.0.1 — 2023-10-13

## README

> It's a toolkit for nodejs WebSocket.

## Functions
```typescript
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;
}
```

---
_Source: https://npm.io/package/one-server-ws · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._