dart_node_ws library

External Documentation

WebSocket bindings for Dart on Node.js

Classes

WebSocketClient

High-level wrapper for a WebSocket client connection.

WebSocketServer

WebSocket server wrapper

Enums

WebSocketReadyState

WebSocket connection ready states as defined by the WebSocket API.

Extension Types

JSIncomingMessage

JS IncomingMessage for upgrade request

JSWebSocket

JS interop binding for a WebSocket connection from the 'ws' package.

JSWebSocketServer

JS interop binding for the WebSocket Server from the 'ws' package.

Functions

createWebSocketServer({required int port}) → WebSocketServer

Creates a WebSocket server on the specified port

Typedefs

CloseEventData = ({int code, String reason})
WebSocket close event data containing the close code and reason.
CloseHandler = void Function(CloseEventData data)
WebSocket close handler
ConnectionHandler = void Function(WebSocketClient client)
WebSocket connection handler
ErrorHandler = void Function(WebSocketError error)
WebSocket error handler
MessageHandler = void Function(WebSocketMessage message)
WebSocket message handler
WebSocketError = ({String? code, String message})
WebSocket error data container.
WebSocketMessage = ({List<int>? bytes, String? text})
WebSocket message data container.