Realtime

// access
nexus.realtime

EventHandlerCopy Anchor Link

export type EventHandler = (data: unknown) => void;

NexusRealtimeCopy Anchor Link

Realtime messaging over Socket.IO. Authenticated with the API key + journey identity. socket.io-client is an optional peer dependency (loaded on demand).

NexusRealtimeCopy Anchor Link

new NexusRealtime(cfg: ResolvedConfig, id: NexusIdentity)

Parameters

Returns NexusRealtime

isConnectedCopy Anchor Link

readonly isConnected: boolean

connect()Copy Anchor Link

async connect(): Promise<void>

Open the connection. Idempotent, and safe under concurrent callers — a connection already open (or being opened) is reused, never duplicated. Rooms are re-joined after every reconnect.

join()Copy Anchor Link

async join(room: string): Promise<unknown>

Join a room. Idempotent — a room already joined this session is not re-emitted (the reconnect handler re-joins it automatically). Returns the server ack ({ ok, room, related }), or a synthetic ack when already joined.

Parameters

Returns Promise<unknown>

leave()Copy Anchor Link

async leave(room: string): Promise<unknown>

Leave a room.

Parameters

Returns Promise<unknown>

emit()Copy Anchor Link

async emit(room: string, event: string | string[], payload?: unknown): Promise<unknown>

Emit one or more named events to a room with a payload.

Parameters

Returns Promise<unknown>

on()Copy Anchor Link

on(event: string, handler: EventHandler): () => void

Listen for a server event. Multiple handlers per event are supported. Registering the SAME handler twice is a no-op (never stacks a duplicate socket listener). Returns an unsubscribe function — call it (e.g. from a component's teardown) instead of leaking a listener on every remount.

Parameters

Returns () => void

off()Copy Anchor Link

off(event: string, handler?: EventHandler): void

Stop listening. With a handler, removes just that one; without, removes every handler for the event.

Parameters

disconnect()Copy Anchor Link

disconnect(): void