kaven-utils - v6.1.9
    Preparing search index...

    Interface IRelayClientConnectOptions

    Options accepted by RelayClient.Connect.

    interface IRelayClientConnectOptions {
        localPort?: number;
        name?: string;
        retries?: number;
        retryIndefinitely?: boolean;
        timeout?: number;
        tls?: ConnectionOptions;
    }
    Index
    localPort?: number

    Local TCP port used for the relay connection.

    name?: string

    A human-chosen name to advertise to other peers via an identify message once connected (e.g. a target ID origins can select by). When omitted the client stays anonymous.

    retries?: number

    Number of times to retry the connection when a transient error (e.g. EADDRNOTAVAIL, ECONNREFUSED) is encountered. Defaults to 3. Ignored when retryIndefinitely is set.

    retryIndefinitely?: boolean

    When true, keep retrying transient connection errors forever (with backoff capped at ~5s). Useful for long-running clients/daemons that should wait for the relay server to become reachable instead of crashing. Defaults to false.

    timeout?: number

    Timeout, in milliseconds, applied to the connection attempt.

    tls?: ConnectionOptions

    Connect over TLS instead of plain TCP.