Skip to content

SubprocessConnectOptions

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

Options for subprocessConnect, which spawns a server process and pipes to it.

optional cwd?: string;

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

Working directory for the spawned process. Defaults to the current directory.


optional env?: Record<string, string>;

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

Extra environment variables, merged over the current process.env.


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


optional stderr?: "inherit" | "pipe" | "ignore";

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

How to handle the child’s stderr. Defaults to "ignore".