Skip to main content
Module

x/tpy/mod.ts>TpyWs

🔑 A strongly typed Pylon API client.
insyri/tpy
Go to Latest
class TpyWs
Re-export
import { TpyWs } from "https://deno.land/x/tpy@v1.0.0-pre-release-2/mod.ts";

The Tpy WebSocket manager.

Constructors

new
TpyWs(
tpyInstance: Tpy,
deploymentID: StringifiedNumber,
reconnectionTimeout?,
)

Properties

private
deploymentID: StringifiedNumber
private
reconnectionTimout: number
private
tpyc: Tpy
private
tryToConnect: boolean
private
optional
ws: WebSocket
rawEventEmitter: EventEmitter

Methods

private
onClose(event: CloseEvent)
private
onError(event: Event | ErrorEvent)
private
onMessage(event: MessageEvent<string>)
private
onOpen(event: Event)
close()

Closes the WebSocket connection, reconnection will not be attempted.

connect()

Retrieves the workbench URL and ties the WebSocket events to an event emitter.

on(type: "open", callback: (data: Event) => void): EventEmitter

Adds an event listener to WebSocket events.

on(type: "close", callback: (data: CloseEvent) => void): EventEmitter

Adds an event listener to WebSocket events.

on(type: "error", callback: (data: ErrorEvent | Event) => void): EventEmitter

Adds an event listener to WebSocket events.

on<C extends unknown[] = unknown[]>(type: "message", callback: (data: Unpacked<Pylon.WebSocketResponse<C>>) => void): EventEmitter

Adds an event listener to WebSocket events.

unpack<T extends unknown[] = unknown[]>(res: Pylon.WebSocketResponse<T>): Unpacked<Pylon.WebSocketResponse<T>>

Unpacks the WebSocket response to a less nested level.