Documentation

Everything you need to get started with SOCKJS and build real-time applications.

Quick Start

Get up and running in under 5 minutes

1. Install via CDN

2. Or via npm

npm install sockjs-client

3. Connect to server

const sock = new SockJS('http://localhost:9999/echo'); sock.onopen = () => console.log('Connected'); sock.onmessage = (e) => console.log('Received:', e.data);

Documentation

Getting Started

Installation, basic setup, and first connection

Installation
Basic Usage
Configuration
Browser Support

View docs

API Reference

Complete client and server API documentation

Client API
Server API
Events
Error Handling

View docs

Protocols

Understanding transport protocols and fallbacks

WebSocket
HTTP Streaming
HTTP Polling
EventSource

View docs

Examples

Real-world examples and code samples

Chat App
Real-time Dashboard
Notifications
Gaming

View docs

Server Setup

Configure and deploy SOCKJS servers

Node.js Server
Python Server
Java Server
Go Server

View docs

Advanced Topics

Scaling, security, and performance optimization

Load Balancing
Security
Performance
Debugging

View docs

Can't find what you're looking for?

Search our documentation or ask the community

Documentation

Everything you need to get started with SOCKJS and build real-time applications.

Quick Start

Get up and running in under 5 minutes

1. Install via CDN

2. Or via npm

npm install sockjs-client

3. Connect to server

const sock = new SockJS('http://localhost:9999/echo'); sock.onopen = () => console.log('Connected'); sock.onmessage = (e) => console.log('Received:', e.data);