UNPKG

1.08 kBTypeScriptView Raw
1import { Transport } from "../transport.js";
2import type { Packet, RawData } from "engine.io-parser";
3export declare abstract class BaseWS extends Transport {
4 protected ws: any;
5 get name(): string;
6 doOpen(): this;
7 abstract createSocket(uri: string, protocols: string | string[] | undefined, opts: Record<string, any>): any;
8 /**
9 * Adds event listeners to the socket
10 *
11 * @private
12 */
13 private addEventListeners;
14 write(packets: any): void;
15 abstract doWrite(packet: Packet, data: RawData): any;
16 doClose(): void;
17 /**
18 * Generates uri for connection.
19 *
20 * @private
21 */
22 private uri;
23}
24/**
25 * WebSocket transport based on the built-in `WebSocket` object.
26 *
27 * Usage: browser, Deno, Bun
28 *
29 * @see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
30 * @see https://caniuse.com/mdn-api_websocket
31 */
32export declare class WS extends BaseWS {
33 createSocket(uri: string, protocols: string | string[] | undefined, opts: Record<string, any>): any;
34 doWrite(_packet: Packet, data: RawData): void;
35}