MethodInfo

Describes a single RPC method as reported by the server’s __describe__ response.

Properties

optional defaults?: Record<string, any>;

Default values applied to omitted parameters before a call is sent.

optional doc?: string;

Human-readable documentation for the method, if the server provides it.

optional headerSchema?: Schema<any>;

Arrow schema of the stream’s one-time header row, when the method declares one.

optional inputSchema?: Schema<any>;

Arrow schema of the per-batch input rows for exchange streams, when available.

name: string;

The method name as invoked by RpcClient.call / RpcClient.stream.

optional outputSchema?: Schema<any>;

Arrow schema of the per-batch output rows for stream methods, when available.

paramsSchema: Schema;

Arrow schema of the call parameters.

optional paramTypes?: Record<string, string>;

Per-parameter human-readable type names, if the server provides them.

resultSchema: Schema;

Arrow schema of a unary result; for stream methods this holds the per-batch output schema.

type: "unary" | "stream";

Whether the method is a single request/response (unary) or a streaming method (stream).