Skip to content
Node: ws8 APIs

ws

Package ws provides WebSocket client and server helpers. Node equivalent: ws, lightweight socket.io patterns.

import "github.com/sahilkhaire/gox/ws"
## API reference

Select a symbol below — each page explains what it does, shows Node.js vs Go comparisons, and includes a runnable example.

Types

SymbolNode.jsKindSummary
ConntypeConn wraps a gorilla WebSocket connection with JSON helpers.
ServertypeServer registers WebSocket routes.
UpgradertypeUpgrader upgrades HTTP connections to WebSocket.
WSHandlertypeWSHandler is a WebSocket connection handler.

Methods

SymbolNode.jsKindSummary
Conn.DialmethodDial connects to the WebSocket url.
Server.NewServermethodNewServer creates a WebSocket server with the given upgrader (nil uses DefaultUpgrader).
Conn.UpgrademethodUpgrade upgrades the HTTP request on w/r using up (nil uses DefaultUpgrader).

Variables

SymbolNode.jsKindSummary
DefaultUpgradervarDefaultUpgrader allows all origins (suitable for tests; tighten in production).

MIT Licensed · Built for Node.js developers moving to Go