Class RealtimeClient

The isomorphic realtime client.

The same Broadcaster API the backend uses, aimed at a server: broadcast/to().emit send an event up the socket, on subscribes a local listener to incoming events. Runs in the browser (global WebSocket) and on Node (lazy optional ws), so the domain code that emits and listens is written once and the transport is resolved by the context.

Implements

Broadcaster

Index

Constructors

Properties

Accessors

Methods

broadcast close connect members on subscribe to unsubscribe create

Constructors

constructor

new RealtimeClient(options: RealtimeClientOptions): RealtimeClient
Parameters
- options: RealtimeClientOptions
  The client options.
Returns RealtimeClient

Properties

`Readonly`name

name: string = 'client'

A human-readable name (e.g. 'memory', 'redis').

Accessors

connected

get connected(): boolean

Whether the socket is open.

Returns boolean
True once connected.

Methods

broadcast

broadcast<T = unknown>(
    channel: string,
    event: string,
    payload?: T,
): Promise<void>
Type Parameters
- T = unknown
Parameters
- channel: string
- event: string
- Optionalpayload: T
Returns Promise<void>

Inherit Doc

Implementation of Broadcaster.broadcast

close

close(): void

Close the connection.

Returns void

connect

connect(): Promise<void>

Open the connection (idempotent).

Returns Promise<void>
A promise that resolves once the socket is open.

members

members(_channel: string): Promise<PresenceMember<unknown>[]>
Parameters
- _channel: string
Returns Promise<PresenceMember<unknown>[]>

Inherit Doc

Implementation of Broadcaster.members

on

on<T = unknown>(channel: string, listener: RealtimeListener<T>): () => void
Type Parameters
- T = unknown
Parameters
- channel: string
- listener: RealtimeListener<T>
Returns () => void

Inherit Doc

Implementation of Broadcaster.on

subscribe(channel: string): Promise<void>
Subscribe the connection to a channel on the server.
Parameters
- channel: string
  The channel.
Returns Promise<void>

to

to(
channel: string,
): { emit: <T = unknown>(event: string, payload?: T) => Promise<void> }
Parameters
- channel: string
Returns { emit: <T = unknown>(event: string, payload?: T) => Promise<void> }

Inherit Doc

Implementation of Broadcaster.to

unsubscribe

unsubscribe(channel: string): Promise<void>
Unsubscribe the connection from a channel on the server.
Parameters
- channel: string
  The channel.
Returns Promise<void>

`Static`create

create(options: RealtimeClientOptions): RealtimeClient
Create a realtime client.
Parameters
- options: RealtimeClientOptions
  The client options.
Returns RealtimeClient
A new client.