Interface UseSemanticRelayResult

Value exposed by useSemanticRelay().

interface UseSemanticRelayResult {
    client: SemanticRelayClient | null;
    error: Error | null;
    isConnected: boolean;
    session: SessionInfo | null;
    state: RelayConnectionState;
    transportKind: RelayTransportKind | null;
}

Properties

The underlying client instance, or null when disconnected / disabled.

error: Error | null

Last error surfaced by the client, if any.

isConnected: boolean

Convenience: state === 'connected'.

session: SessionInfo | null

Snapshot returned at connect time, if any.

Current connection state.

transportKind: RelayTransportKind | null

Which transport the connection uses ('webtransport' preferred, 'websocket' fallback), or null before connect / when disabled.