Skip to main content
Module

x/aleph/std.ts>ws.WebSocket

The Full-stack Framework in Deno.
postui/aleph.js
Very Popular
Go to Latest
interface ws.WebSocket
implements AsyncIterable<WebSocketEvent>
import { type ws } from "https://deno.land/x/aleph@v0.2.13/std.ts";
const { WebSocket } = ws;

Properties

readonly
conn: Deno.Conn
readonly
isClosed: boolean

Methods

[[Symbol.asyncIterator]](): AsyncIterableIterator<WebSocketEvent>
send(data: WebSocketMessage): Promise<void>
ping(data?: WebSocketMessage): Promise<void>
close(): Promise<void>

Close connection after sending close frame to peer. This is canonical way of disconnection but it may hang because of peer's response delay. Default close code is 1000 (Normal Closure)

close(code: number): Promise<void>
close(code: number, reason: string): Promise<void>
closeForce(): void

Close connection forcely without sending close frame to peer. This is basically undesirable way of disconnection. Use carefully.