MethodInfo
Defined in: src/client/introspect.ts:31
Describes a single RPC method as reported by vgi_rpc.Reflection.v1.
Properties
Section titled “Properties”defaults?
Section titled “defaults?”optional defaults?: Record<string, any>;Defined in: src/client/introspect.ts:59
Default values applied to omitted parameters before a call is sent.
optional doc?: string;Defined in: src/client/introspect.ts:55
Human-readable documentation for the method, if the server provides it.
hasReturn?
Section titled “hasReturn?”optional hasReturn?: boolean;Defined in: src/client/introspect.ts:39
Whether the method returns a value at all. false for a void method,
whose reply carries no data batch. Absent when the description came from
a caller-supplied literal rather than from the server.
headerSchema?
Section titled “headerSchema?”optional headerSchema?: Schema<any>;Defined in: src/client/introspect.ts:50
Arrow schema of the stream’s one-time header row, when the method declares one.
inputSchema?
Section titled “inputSchema?”optional inputSchema?: Schema<any>;Defined in: src/client/introspect.ts:46
Arrow schema of the per-batch input rows for exchange streams, when available.
name: string;Defined in: src/client/introspect.ts:33
The method name as invoked by RpcClient.call / RpcClient.stream.
outputSchema?
Section titled “outputSchema?”optional outputSchema?: Schema<any>;Defined in: src/client/introspect.ts:48
Arrow schema of the per-batch output rows for stream methods, when available.
paramsSchema
Section titled “paramsSchema”paramsSchema: Schema;Defined in: src/client/introspect.ts:41
Arrow schema of the call parameters.
paramTypes?
Section titled “paramTypes?”optional paramTypes?: Record<string, string>;Defined in: src/client/introspect.ts:57
Per-parameter human-readable type names, if the server provides them.
resultSchema
Section titled “resultSchema”resultSchema: Schema;Defined in: src/client/introspect.ts:44
Arrow schema of a unary result; empty for a stream, whose per-batch output schema arrives with the stream itself.
streamKind?
Section titled “streamKind?”optional streamKind?: string;Defined in: src/client/introspect.ts:53
What the stream does: "producer", "exchange", or "unknown" where
the server cannot say. Empty for a unary method.
type: "unary" | "stream";Defined in: src/client/introspect.ts:35
Whether the method is a single request/response (unary) or a streaming method (stream).