Class Socket

Index

Constructors

Methods

close errorLogger send tryConnect

Properties

autoReconnect binaryType connected connectionTimeout onBeforeConnect onclose onerror onmessage onopen proxy socket url

Constructors

constructor

new Socket(url: string, params?: Partial<SocketParams>): Socket
Parameters
- url: string
- params: Partial<SocketParams> = {}
Returns Socket

Methods

close

close(code?: number): void
Parameters
- Optionalcode: number
Returns void

errorLogger

errorLogger(...args: any[]): void
Parameters
- ...args: any[]
Returns void

send

send(data: string | Uint8Array<ArrayBuffer>): void
Parameters
- data: string | Uint8Array<ArrayBuffer>
Returns void

tryConnect

tryConnect(tries?: number): Promise<boolean>
Parameters
- tries: number = 1
Returns Promise<boolean>

Properties

autoReconnect

autoReconnect: boolean = false

binaryType

binaryType: string = ''

connected

connected: boolean = false

connectionTimeout

connectionTimeout: number = 5000

onBeforeConnect

onBeforeConnect: (() => void) | null = null

onclose

onclose: (event: CloseEvent) => void = ...

onerror

onerror: (event: Event) => void = ...

onmessage

onmessage: (event: MessageEvent) => void = ...

onopen

onopen: () => void = ...

proxy

proxy: string | null

socket

socket: WebSocket | WWWebSocket | null = null

url

url: string