Skip to content

TcpConnectOptions

Defined in: src/client/types.ts:105

Options for tcpConnect, the raw-TCP-socket RPC client.

SECURITY: raw TCP carries no authentication or TLS — connect only to trusted endpoints (use httpConnect for untrusted networks).

optional externalLocation?: ExternalLocationConfig;

Defined in: src/client/types.ts:96

External storage config for resolving externalized batches.

PipeConnectOptions.externalLocation


optional onLog?: (msg) => void;

Defined in: src/client/types.ts:94

Callback invoked for each log/error message the server emits during a request.

Parameter Type
msg LogMessage

void

PipeConnectOptions.onLog


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.

PipeConnectOptions.protocol