```sh npm install --save extra-websocket # or yarn add extra-websocket ```
npm install extra-websocketsh
npm install --save extra-websocket
or
yarn add extra-websocket
`API
$3
ts
import { WebSocket, Event as OpenEvent, MessageEvent, ErrorEvent, CloseEvent } from 'ws'
import { Emitter } from '@blackglory/structures'enum BinaryType {
NodeBuffer
, ArrayBuffer
, Fragments
}
enum State {
Closed
, Connecting
, Connected
, Closing
}
class ExtraWebSocket extends Emitter<{
open: [event: OpenEvent]
message: [event: MessageEvent]
error: [event: ErrorEvent]
close: [event: CloseEvent]
}> {
constructor(createWebSocket: () => WebSocket)
getState(): State
getBinaryType(): BinaryType
setBinaryType(val: BinaryType): void
connect(signal?: AbortSignal): Promise
close(code?: number, reason?: string): Promise
send(data: string | ArrayBufferLike | Buffer | TypedArray | DataView): void
ping(): void
}
`$3
ts
function autoReconnect(
ws: ExtraWebSocket
, reconnectInterval: number = 0
, connectTimeout?: number
): () => void
`$3
ts
function autoReonnectWithExponentialBackOff(
ws: ExtraWebSocket
, reconnectInterval: {
baseInterval: number
maxInterval?: number = Infinity
factor?: number = 2
jitter?: boolean = true
}
, connectTimeout?: number
): () => void
`$3
ts
function startHeartbeat(ws: ExtraWebSocket, interval: number): () => void
``