AngularTS
    Preparing search index...

    Interface WebSocketConfig

    WebSocket-specific configuration

    interface WebSocketConfig {
        eventTypes?: string[];
        heartbeatTimeout?: number;
        maxRetries?: number;
        onClose?: (event: CloseEvent) => void;
        onError?: (err: Event) => void;
        onEvent?: (message: ConnectionEvent) => void;
        onMessage?: (data: unknown, event: Event | MessageEvent<any>) => void;
        onOpen?: (event: Event) => void;
        onProtocolMessage?: (
            data: RealtimeProtocolMessage,
            event: Event | MessageEvent<any>,
        ) => void;
        onReconnect?: (attempt: number) => void;
        protocols?: string[];
        retryDelay?: number;
        transformMessage?: (data: string) => unknown;
    }

    Hierarchy (View Summary)

    Index

    Properties

    eventTypes? heartbeatTimeout? maxRetries? onClose? onError? onEvent? onMessage? onOpen? onProtocolMessage? onReconnect? protocols? retryDelay? transformMessage?

    Properties
    eventTypes?: string[]

    Additional EventSource event names to subscribe to

    heartbeatTimeout?: number

    Timeout in milliseconds to detect heartbeat inactivity

    maxRetries?: number

    Maximum number of reconnect attempts

    onClose?: (event: CloseEvent) => void

    Called when a WebSocket connection closes

    onError?: (err: Event) => void

    Called when an error occurs

    onEvent?: (message: ConnectionEvent) => void

    Called with every registered connection message, including custom SSE event types

    onMessage?: (data: unknown, event: Event | MessageEvent<any>) => void

    Called when a message is received

    onOpen?: (event: Event) => void

    Called when the connection opens

    onProtocolMessage?: (
        data: RealtimeProtocolMessage,
        event: Event | MessageEvent<any>,
    ) => void

    Called when a decoded message uses the realtime protocol shape.

    onReconnect?: (attempt: number) => void

    Called when a reconnect attempt happens

    protocols?: string[]

    Optional WebSocket subprotocols

    retryDelay?: number

    Delay between reconnect attempts in milliseconds

    transformMessage?: (data: string) => unknown

    Function to transform incoming messages

    Settings
    Member Visibility

    On This Page
    Properties