Documentation / zerotal / client / SocketOptions

Interface: SocketOptions

Defined in: packages/client/src/Socket.ts:48

Properties

url?

optional url?: string

Defined in: packages/client/src/Socket.ts:53

Full WebSocket URL. When omitted it's derived from the page location (browser) as ws(s)://<host>:<port><path>. Required in non-browser environments.

path?

optional path?: string

Defined in: packages/client/src/Socket.ts:55

WebSocket upgrade path. Defaults to /app/ws (matches the broadcasting config default).

host?

optional host?: string

Defined in: packages/client/src/Socket.ts:57

Host override (defaults to location.hostname).

port?

optional port?: string | number

Defined in: packages/client/src/Socket.ts:59

Port override (defaults to location.port).

scheme?

optional scheme?: "ws" | "wss"

Defined in: packages/client/src/Socket.ts:61

Force a scheme. Defaults to wss on https pages, ws otherwise.

auth?

optional auth?: object

Defined in: packages/client/src/Socket.ts:68

Authentication for the connection and for private/presence channels:

params — query params appended to the WS URL (browsers can't set WS headers), read by the server on upgrade.
headers — sent on the POST /broadcasting/auth request (e.g. a CSRF token).

params?

optional params?: Record<string, string>

headers?

optional headers?: Record<string, string>

authEndpoint?

optional authEndpoint?: string | false

Defined in: packages/client/src/Socket.ts:74

Endpoint that signs a private/presence subscription (Pusher-style). Defaults to /broadcasting/auth. Set to false to skip the signature fetch and rely on connection-level authorization instead.