Interface UseSemanticRelayResult

Value exposed by useSemanticRelay().

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

Index

Properties

client error isConnected session state

Properties

client

client: SemanticRelayClient | null

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

error

error: Error | null

Last error surfaced by the client, if any.

isConnected

isConnected: boolean

Convenience: state === 'connected'.

session

session: SessionInfo | null

Snapshot returned at connect time, if any.

state

state: RelayConnectionState

Current connection state.