Provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection.
If you are looking to create a WebSocket server, please take a look at
Deno.upgradeWebSocket().
Properties Jump to heading
Returns a string that indicates how binary data from the WebSocket object is exposed to scripts:
Can be set, to change how binary data is returned. The default is "blob".
Jump to headingbufferedAmount: numberReturns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.
If the WebSocket connection is closed, this attribute's value will only increase with each call to the send() method. (The number does not reset to zero once the connection closes.)
Jump to headingextensions: stringReturns the extensions selected by the server, if any.
Jump to headingonclose: ((this: WebSocket,ev: CloseEvent,) => any) | nullJump to headingonerror: ((this: WebSocket,ev: Event | ErrorEvent,) => any) | nullJump to headingonmessage: ((this: WebSocket,ev: MessageEvent,) => any) | nullJump to headingonopen: (() => any) | nullJump to headingprotocol: stringReturns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.
Jump to headingreadyState: numberReturns the state of the WebSocket object's connection. It can have the values described below.
Jump to headingurl: stringReturns the URL that was used to establish the WebSocket connection.
Jump to headingCLOSED: numberJump to headingCLOSING: numberJump to headingCONNECTING: numberJump to headingOPEN: numberMethods Jump to heading
Jump to headingclose(code?: number,reason?: string,): voidCloses the WebSocket connection, optionally using code as the WebSocket connection close code and reason as the WebSocket connection close reason.
Jump to headingsend(data: ): voidTransmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.
Jump to headingaddEventListener<K extends keyof WebSocketEventMap>(type: K,listener: (this: WebSocket,ev: WebSocketEventMap[K],) => any,options?: boolean | AddEventListenerOptions,): voidJump to headingaddEventListener(type: string,listener: EventListenerOrEventListenerObject,options?: boolean | AddEventListenerOptions,): voidJump to headingremoveEventListener<K extends keyof WebSocketEventMap>(type: K,listener: (this: WebSocket,ev: WebSocketEventMap[K],) => any,options?: boolean | EventListenerOptions,): void