describeProtocol
function describeProtocol(target, name): Promise<ServiceDescription>;Defined in: src/client/introspect.ts:544
Describe one hosted protocol, over a client the caller already holds.
Two round trips on target’s connection: list_protocols (for the server
identity the description carries, and to tell “no reflection” apart from
“no such protocol”), then describe(name). The connection rules are those
of listProtocols.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
target |
RpcClient |
- |
name |
string |
The protocol’s wire name, as listProtocols reports it. |
Returns
Section titled “Returns”Promise<ServiceDescription>
Throws
Section titled “Throws”The server does not host reflection.
Throws
Section titled “Throws”The server does not host name (errorKind
"protocol_not_supported"), answered with another error, or the
transport failed.