Documentation / @super-line/client

@super-line/client

The client for super-line — end-to-end typesafe WebSockets for TypeScript. A typed proxy over the global WebSocket: call requests, listen to events, subscribe to topics — with auto-reconnect and at-most-once delivery.

pnpm add @super-line/core @super-line/client zod

import { createClient } from '@super-line/client'
import { api } from './contract'

const client = createClient(api, { url: 'ws://localhost:3000', role: 'user' })

client.on('message', (m) => console.log(m.text))   // typed
const sub = client.subscribe('prices', (p) => render(p))
await sub.ready

const out = await client.send({ text: 'hi' })       // throws typed SocketError on failure
client.close()

The client is narrowed to its role's surface (shared ∪ role). Works in browsers and Node 22+ (pass { WebSocket } on older runtimes).

• 📖 Docs: https://mertdogar.github.io/super-line/
• 📚 Guides: requests, reconnection & delivery
• 📕 API reference: https://mertdogar.github.io/super-line/reference/
• 🧩 Source: https://github.com/mertdogar/super-line

MIT © Mert

Interfaces

• BackoffOptions
• CallOptions
• ClientOptions
• Subscription
• ValidationErrorInfo

Type Aliases

• Client
• ClientMethods
• ServerHandlers

Functions

• backoffDelay
• createClient