Interface RealtimeClient

interface RealtimeClient {
connect<Input, Output>(app: string, handler: RealtimeConnectionHandler<Output>): RealtimeConnection<Input>;
open<Extension>(extension: Extension, options: RealtimeExtensionOptions<Extension> & RealtimeOpenOptions): ManagedRealtimeSession<RealtimeExtensionSession<Extension>>;
}

Index

Methods

Methods

connect

connect<Input, Output>(app, handler): RealtimeConnection<Input>
Connect to the realtime endpoint. The default implementation uses WebSockets to connect to fal function endpoints that support WSS.
Type Parameters
- Input = any
- Output = any
Parameters
- app: string
  the app alias or identifier.
- handler: RealtimeConnectionHandler<Output>
  the connection handler.
Returns RealtimeConnection<Input>
- Defined in realtime.ts:342

open

open<Extension>(extension, options): ManagedRealtimeSession<RealtimeExtensionSession<Extension>>
Experimental
Open a model-specific realtime session with an explicitly supplied extension. This form preserves the extension's options and session types.

Returns the managed session SYNCHRONOUSLY, in state "opening", while negotiation starts eagerly behind it — the caller holds a usable handle immediately, send() queues until the session is live, and failures arrive through onError and onState("failed"). Await session.ready for the promise-style call site; misconfiguration (no endpoint, an endpoint the extension rejects) still throws synchronously.

The fal.realtime.open() extension API is experimental and may change in a minor release.
Type Parameters
- Extension extends AnyRealtimeExtension
Parameters
- extension: Extension
- options: RealtimeExtensionOptions<Extension> & RealtimeOpenOptions
Returns ManagedRealtimeSession<RealtimeExtensionSession<Extension>>
- Defined in realtime.ts:359