mirror of
https://github.com/socketio/socket.io.git
synced 2026-01-09 15:08:12 -05:00
175a2c58c1
Before this change, the following error would be thrown when compiling
with TypeScript:
```
node_modules/engine.io-client/build/esm/transports/websocket.node.d.ts:12:101 - error TS1340: Module 'ws' does not refer to a type, but is used as a type here. Did you mean 'typeof import('ws')'?
12 createSocket(uri: string, protocols: string | string[] | undefined, opts: Record<string, any>): import("ws");
~~~~~~~~~~~~
```
This behavior was introduced in [1], included in version `6.6.0`.
The return type is forced as `any`, so that the `@types/ws` dependency
is optional.
[1]: f4d898ee96
Related: https://github.com/socketio/socket.io/issues/5202
51 lines
1.4 KiB
TypeScript
51 lines
1.4 KiB
TypeScript
import { WebSocket } from "ws";
|
|
import type { Packet, RawData } from "engine.io-parser";
|
|
import { BaseWS } from "./websocket.js";
|
|
|
|
/**
|
|
* WebSocket transport based on the `WebSocket` object provided by the `ws` package.
|
|
*
|
|
* Usage: Node.js, Deno (compat), Bun (compat)
|
|
*
|
|
* @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
|
|
* @see https://caniuse.com/mdn-api_websocket
|
|
*/
|
|
export class WS extends BaseWS {
|
|
createSocket(
|
|
uri: string,
|
|
protocols: string | string[] | undefined,
|
|
opts: Record<string, any>,
|
|
): any {
|
|
if (this.socket?._cookieJar) {
|
|
opts.headers = opts.headers || {};
|
|
|
|
opts.headers.cookie =
|
|
typeof opts.headers.cookie === "string"
|
|
? [opts.headers.cookie]
|
|
: opts.headers.cookie || [];
|
|
for (const [name, cookie] of this.socket._cookieJar.cookies) {
|
|
opts.headers.cookie.push(`${name}=${cookie.value}`);
|
|
}
|
|
}
|
|
return new WebSocket(uri, protocols, opts);
|
|
}
|
|
|
|
doWrite(packet: Packet, data: RawData) {
|
|
const opts: { compress?: boolean } = {};
|
|
if (packet.options) {
|
|
opts.compress = packet.options.compress;
|
|
}
|
|
|
|
if (this.opts.perMessageDeflate) {
|
|
const len =
|
|
// @ts-ignore
|
|
"string" === typeof data ? Buffer.byteLength(data) : data.length;
|
|
if (len < this.opts.perMessageDeflate.threshold) {
|
|
opts.compress = false;
|
|
}
|
|
}
|
|
|
|
this.ws.send(data, opts);
|
|
}
|
|
}
|