method TpyWs.prototype.on

import { TpyWs } from "https://deno.land/x/tpy@v1.0.0-RC/src/ws.ts";

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<T extends unknown[]>(type: "message", callback: (data: Unpacked<PylonWebSocket.Response<T>>) => void): EventEmitter

Adds an event listener to WebSocket events.

Parameters

type: "open"

Fired when the WebSocket is (re)opened.

callback: (data: Event) => void

A callback function to invoke when this event is fired.

Returns

Adds an event listener to WebSocket events.

type: "close"

Fired when the WebSocket is closed.

callback: (data: CloseEvent) => void

A callback function to invoke when this event is fired.

Adds an event listener to WebSocket events.

type: "error"

Fired when the WebSocket captures an error.

callback: (data: ErrorEvent | Event) => void

A callback function to invoke when this event is fired.

This event is fired every time the WebSocket is closed. This is an action of the Pylon backend marking closed connections as errors.

Adds an event listener to WebSocket events.

T extends unknown[]

The type of the data object inside PylonWebSocket.Response.

type: "message"

Fired when the WebSocket recieves a message.

callback: (data: Unpacked<PylonWebSocket.Response<T>>) => void

A callback function to invoke when this event is fired.