websockets

Open, send over, and close WebSocket connections, with event handlers wired up in one call.

Import: @rtorcato/browser-common/websockets

📖 MDN: WebSockets API · 📊 caniuse: websockets

Browser support

API	Chrome	Edge	Firefox	Safari	iOS Safari	Baseline
WebSocket	✅ 5+	✅ 12+	✅ 11+	✅ 5+	✅ 4.2+	Widely available

✅ supported · ◐ partial · ❌ not supported · [n] see note. Generated from MDN browser-compat-data and web-features. caniuse: WebSocket

Example

import {
  isWebSocketAvailable,
  createWebSocket,
  sendWebSocketMessage,
  closeWebSocket,
} from '@rtorcato/browser-common/websockets'

if (isWebSocketAvailable()) {
  const ws = createWebSocket('wss://example.com', undefined, {
    onMessage: (e) => console.log(e.data),
  })
  sendWebSocketMessage(ws, JSON.stringify({ ping: 1 }))
  closeWebSocket(ws, 1000, 'done')
}

Exports

• isWebSocketAvailable() — feature check
• createWebSocket(url, protocols?, handlers?) — opens a connection and attaches onOpen/onMessage/onError/onClose handlers
• sendWebSocketMessage(ws, data) — sends if the socket is open; returns true/false
• closeWebSocket(ws, code?, reason?) — closes if open or connecting

See the API reference for full signatures.