foundation-comms.socketconnectoptions

Home > @genesislcap/foundation-comms > SocketConnectOptions

SocketConnectOptions type

The Socket connection options definition.

Signature:

export type SocketConnectOptions = {
    alwaysOn?: boolean;
    connectObserver?: Observer<Message>;
    enableHeartbeat?: boolean;
    enableHeartbeatLogging?: boolean;
    enableMessageLogging?: boolean;
    heartbeatInterval?: number;
    verboseHeartbeat?: boolean;
    heartbeatPingCallback?: (message: PingMessage) => void;
    heartbeatPongCallback?: (message: PongMessage) => void;
    proxyPath?: string;
};

References: Message, PingMessage, PongMessage