Socks5hTcpConnectOptions
Defined in: src/client/types.ts:108
Options for the Node-only tcpConnectSocks5h constructor.
Extends
Section titled “Extends”Properties
Section titled “Properties”connectTimeoutMs?
Section titled “connectTimeoutMs?”optional connectTimeoutMs?: number;Defined in: src/client/types.ts:110
One deadline for proxy TCP setup and the complete SOCKS5 negotiation. Default: 5000 ms.
externalLocation?
Section titled “externalLocation?”optional externalLocation?: ExternalLocationConfig;Defined in: src/client/types.ts:96
External storage config for resolving externalized batches.
Inherited from
Section titled “Inherited from”TcpConnectOptions.externalLocation
onLog?
Section titled “onLog?”optional onLog?: (msg) => void;Defined in: src/client/types.ts:94
Callback invoked for each log/error message the server emits during a request.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
msg |
LogMessage |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”protocol?
Section titled “protocol?”optional protocol?: string;Defined in: src/client/types.ts:92
Which protocol to bind to, skipping reflection’s list_protocols hop.
Introspection is two round trips – what does this server host, then describe one of them – because a server may host several and there is no longer a single “the” protocol to ask about without asking. Naming one here answers the first question locally. Defaults to the first hosted protocol that is not framework-reserved.
Inherited from
Section titled “Inherited from”signal?
Section titled “signal?”optional signal?: AbortSignal;Defined in: src/client/types.ts:112
Cancels proxy setup and negotiation.