Interface StarCommsLocalClientConfig

Configuration for the local StarComm WebSocket client.

interface StarCommsLocalClientConfig {
    autoReconnect?: boolean;
    debug?: boolean;
    host?: string;
    initialDelayMs?: number;
    maxAttempts?: number;
    maxDelayMs?: number;
    port?: number;
    token: string;
}

Properties

autoReconnect? debug? host? initialDelayMs? maxAttempts? maxDelayMs? port? token

Properties

OptionalautoReconnect

autoReconnect?: boolean

Whether to automatically reconnect on connection loss.

Default

true

Optionaldebug

debug?: boolean

Enable debug logging to console.

Default

false

Optionalhost

host?: string

Host/IP of the machine running StarComm.

Default

"127.0.0.1"

OptionalinitialDelayMs

initialDelayMs?: number

Initial delay before first reconnect attempt in ms.

Default

1000

OptionalmaxAttempts

maxAttempts?: number

Maximum consecutive reconnect attempts before giving up.

Default

Infinity

OptionalmaxDelayMs

maxDelayMs?: number

Maximum delay between reconnect attempts in ms.

Default

15000

Optionalport

port?: number

LAN control port configured in StarComm's Mobile Remote settings.

Default

8798

token

token: string

Pairing token from StarComm's Mobile Remote settings. Required for authentication — the connection will receive a 401 without it.

Settings

Member Visibility

On This Page

Properties