{ "schemaVersion": "2.0", "id": 550, "name": "@probitas-test/client-grpc", "variant": "project", "kind": 1, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "gRPC client for [Probitas](https://github.com/probitas-test/probitas) scenario testing framework.\n\nThis package provides a gRPC client with Server Reflection support, designed for\nintegration testing of gRPC services. It is a thin wrapper around\n[" }, { "kind": "code", "text": "`@probitas-test/client-connectrpc`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-connectrpc) with\n" }, { "kind": "code", "text": "`protocol: \"grpc\"`" }, { "kind": "text", "text": " pre-configured.\n\n## Features\n\n- **Native gRPC**: Uses gRPC protocol (HTTP/2 with binary protobuf)\n- **Server Reflection**: Auto-discover services and methods at runtime\n- **Field Name Conversion**: Automatic snake_case ↔ camelCase conversion\n- **TLS Support**: Configure secure connections with custom certificates\n- **Duration Tracking**: Built-in timing for performance monitoring\n- **Error Handling**: Test error responses without throwing exceptions\n- **Resource Management**: Implements " }, { "kind": "code", "text": "`AsyncDisposable`" }, { "kind": "text", "text": " for proper cleanup\n\n## Installation\n\n" }, { "kind": "code", "text": "```bash\nnpm install @probitas-test/client-grpc\n```" }, { "kind": "text", "text": "\n\n## Quick Start\n\n" }, { "kind": "code", "text": "```ts\nimport { createGrpcClient } from \"@probitas-test/client-grpc\";\n\n// Create client (uses reflection by default)\nconst client = createGrpcClient({\n url: \"http://localhost:50051\",\n});\n\n// Call a method\nconst response = await client.call(\n \"echo.EchoService\",\n \"echo\",\n { message: \"Hello!\" }\n);\nconsole.log(response.data);\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## Service Discovery\n\n" }, { "kind": "code", "text": "```ts\nimport { createGrpcClient } from \"@probitas-test/client-grpc\";\n\nconst client = createGrpcClient({ url: \"http://localhost:50051\" });\n\n// Discover available services\nconst services = await client.reflection.listServices();\nconsole.log(\"Services:\", services);\n\n// Get method information\nconst info = await client.reflection.getServiceInfo(\"echo.EchoService\");\nconsole.log(\"Methods:\", info.methods);\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## Field Name Conventions\n\nThe client automatically handles field name conversion between protobuf and JavaScript:\n\n- **Request**: Accept both " }, { "kind": "code", "text": "`snake_case`" }, { "kind": "text", "text": " (protobuf) and " }, { "kind": "code", "text": "`camelCase`" }, { "kind": "text", "text": " (JavaScript) field names\n- **Response**:\n - " }, { "kind": "code", "text": "`response.data`" }, { "kind": "text", "text": " — Plain JSON with " }, { "kind": "code", "text": "`camelCase`" }, { "kind": "text", "text": " fields (no " }, { "kind": "code", "text": "`$typeName`" }, { "kind": "text", "text": ")\n - " }, { "kind": "code", "text": "`response.raw`" }, { "kind": "text", "text": " — Original protobuf Message with metadata (includes " }, { "kind": "code", "text": "`$typeName`" }, { "kind": "text", "text": ")\n\n" }, { "kind": "code", "text": "```ts\nimport { createGrpcClient } from \"@probitas-test/client-grpc\";\n\nconst client = createGrpcClient({ url: \"http://localhost:50051\" });\n\n// Request: Both camelCase and snake_case work\nconst response = await client.call(\"echo.Echo\", \"echoWithDelay\", {\n message: \"hello\",\n delayMs: 100, // camelCase (recommended for JavaScript)\n // delay_ms: 100, // snake_case (protobuf style) also works\n});\n\n// Response data: JSON with camelCase fields\nconsole.log(response.data);\n// { message: \"hello\", metadata: {...} } ← no $typeName\n\n// Response raw: protobuf Message with metadata\nconsole.log(response.raw);\n// { $typeName: \"echo.EchoResponse\", message: \"hello\", ... }\n\nawait client.close();\n```" }, { "kind": "text", "text": "\n\n## Using with " }, { "kind": "code", "text": "`using`" }, { "kind": "text", "text": " Statement\n\n" }, { "kind": "code", "text": "```ts\nimport { createGrpcClient } from \"@probitas-test/client-grpc\";\n\nawait using client = createGrpcClient({ url: \"http://localhost:50051\" });\n\nconst res = await client.call(\"echo.EchoService\", \"echo\", { message: \"test\" });\nconsole.log(res.data);\n// Client automatically closed when block exits\n```" }, { "kind": "text", "text": "\n\n## Related Packages\n\n| Package | Description |\n|---------|-------------|\n| [" }, { "kind": "code", "text": "`@probitas-test/client`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client) | Core utilities and types |\n| [" }, { "kind": "code", "text": "`@probitas-test/client-connectrpc`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/@probitas-test/client-connectrpc) | ConnectRPC client (supports Connect, gRPC, gRPC-Web) |\n\n## Links\n\n- [GitHub Repository](https://github.com/probitas-test/probitas-packages)\n- [Probitas Framework](https://github.com/probitas-test/probitas)\n- [gRPC](https://grpc.io/)" } ] }, "children": [ { "id": 598, "name": "GrpcError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error class for ConnectRPC/gRPC errors.\n\nUse " }, { "kind": "code", "text": "`statusCode`" }, { "kind": "text", "text": " to distinguish between different gRPC error codes." } ] }, "children": [ { "id": 599, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 600, "name": "GrpcError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 601, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 602, "name": "statusCode", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 687, "name": "ConnectRpcStatusCode", "package": "@probitas-test/client-connectrpc" } }, { "id": 603, "name": "statusMessage", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 604, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 611, "name": "ConnectRpcErrorOptions", "package": "@probitas-test/client-connectrpc" } } ], "type": { "type": "reference", "target": 598, "name": "ConnectRpcError", "package": "@probitas-test/client-connectrpc" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } } ], "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } }, { "id": 610, "name": "details", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 688, "name": "ErrorDetail", "package": "@probitas-test/client-connectrpc" } } } }, { "id": 606, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "connectrpc" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.kind" } }, { "id": 609, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "union", "types": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "Headers" }, "name": "Headers", "package": "typescript" }, { "type": "literal", "value": null } ] } }, { "id": 605, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.name" } }, { "id": 607, "name": "statusCode", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "reference", "target": 687, "name": "ConnectRpcStatusCode", "package": "@probitas-test/client-connectrpc" } }, { "id": 608, "name": "statusMessage", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/errors.d.ts", "qualifiedName": "ClientError" }, "name": "ClientError", "package": "@probitas-test/client" } ] }, { "id": 614, "name": "GrpcNetworkError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a network-level failure occurs.\n\nThis error indicates that the request could not be processed by the server\ndue to network issues (connection refused, DNS resolution failure, timeout, etc.).\nUnlike ConnectRpcError, this error means the server was never reached." } ] }, "children": [ { "id": 615, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { "id": 616, "name": "GrpcNetworkError", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { "id": 617, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 618, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2022.error.d.ts", "qualifiedName": "ErrorOptions" }, "name": "ErrorOptions", "package": "typescript" } } ], "type": { "type": "reference", "target": 614, "name": "ConnectRpcNetworkError", "package": "@probitas-test/client-connectrpc" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } } ], "overwrites": { "type": "reference", "target": -1, "name": "ClientError.constructor", "package": "@probitas-test/client" } }, { "id": 620, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": "connectrpc" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.kind" } }, { "id": 619, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": -1, "name": "ClientError.name" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/errors.d.ts", "qualifiedName": "ClientError" }, "name": "ClientError", "package": "@probitas-test/client" } ] }, { "id": 688, "name": "ErrorDetail", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Rich error detail from google.rpc.Status.\n\nConnectRPC errors can include structured details encoded in error responses.\nThese details follow the google.protobuf.Any format with a type URL and value." } ] }, "children": [ { "id": 689, "name": "typeUrl", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Type URL identifying the error detail type.\nCommon types include:\n- \"type.googleapis.com/google.rpc.BadRequest\"\n- \"type.googleapis.com/google.rpc.DebugInfo\"\n- \"type.googleapis.com/google.rpc.RetryInfo\"\n- \"type.googleapis.com/google.rpc.QuotaFailure\"" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 690, "name": "value", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Decoded error detail value.\nThe structure depends on the typeUrl." } ] }, "type": { "type": "intrinsic", "name": "unknown" } } ] }, { "id": 565, "name": "GrpcClient", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ConnectRPC client interface.\n\n## Field Name Conventions\n\nThis client automatically handles field name conversion between protobuf and JavaScript:\n\n- **Request fields**: Accept both " }, { "kind": "code", "text": "`snake_case`" }, { "kind": "text", "text": " (protobuf style) and " }, { "kind": "code", "text": "`camelCase`" }, { "kind": "text", "text": " (JavaScript style)\n- **Response fields**: Converted to JavaScript conventions based on response type:\n - " }, { "kind": "code", "text": "`response.data`" }, { "kind": "text", "text": ": Plain JSON object with " }, { "kind": "code", "text": "`camelCase`" }, { "kind": "text", "text": " field names (no " }, { "kind": "code", "text": "`$typeName`" }, { "kind": "text", "text": ")\n - " }, { "kind": "code", "text": "`response.raw`" }, { "kind": "text", "text": ": Original protobuf Message object with all metadata (includes " }, { "kind": "code", "text": "`$typeName`" }, { "kind": "text", "text": ")" } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nconst client = createConnectRpcClient({ url: \"http://localhost:50051\" });\n\n// Request: Both formats work\nawait client.call(\"echo.Echo\", \"echoWithDelay\", {\n message: \"hello\",\n delayMs: 100, // camelCase (recommended)\n // delay_ms: 100, // snake_case also works\n});\n\n// Response: data is JSON, raw is protobuf Message\nconst response = await client.call(\"echo.Echo\", \"echo\", { message: \"test\" });\nconsole.log(response.data); // { message: \"test\", metadata: {...} }\nconsole.log(response.raw); // { $typeName: \"echo.EchoResponse\", message: \"test\", ... }\n```" } ] } ] }, "children": [ { "id": 566, "name": "config", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Client configuration" } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client-connectrpc", "packagePath": "dist/types.d.ts", "qualifiedName": "ConnectRpcClientConfig" }, "name": "ConnectRpcClientConfig", "package": "@probitas-test/client-connectrpc" } }, { "id": 567, "name": "reflection", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Reflection API (only available when schema: \"reflection\")" } ] }, "type": { "type": "reference", "target": 705, "name": "ReflectionApi", "package": "@probitas-test/client-connectrpc" } }, { "id": 589, "name": "bidiStream", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 590, "name": "bidiStream", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Make a bidirectional streaming RPC call." } ] }, "typeParameters": [ { "id": 591, "name": "TRequest", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 592, "name": "serviceName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Service name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 593, "name": "methodName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Method name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 594, "name": "requests", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Async iterable of request messages" } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2018.asynciterable.d.ts", "qualifiedName": "AsyncIterable" }, "typeArguments": [ { "type": "reference", "target": 591, "name": "TRequest", "package": "@probitas-test/client-connectrpc", "refersToTypeParameter": true } ], "name": "AsyncIterable", "package": "typescript" } }, { "id": 595, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Call options" } ] }, "type": { "type": "reference", "target": 621, "name": "ConnectRpcOptions", "package": "@probitas-test/client-connectrpc" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2018.asynciterable.d.ts", "qualifiedName": "AsyncIterable" }, "typeArguments": [ { "type": "reference", "target": 627, "name": "ConnectRpcResponse", "package": "@probitas-test/client-connectrpc" } ], "name": "AsyncIterable", "package": "typescript" } } ] }, { "id": 568, "name": "call", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 569, "name": "call", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Make a unary RPC call." } ] }, "typeParameters": [ { "id": 570, "name": "TRequest", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 571, "name": "serviceName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Service name (e.g., \"echo.EchoService\")" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 572, "name": "methodName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Method name (e.g., \"echo\")" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 573, "name": "request", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Request message" } ] }, "type": { "type": "reference", "target": 570, "name": "TRequest", "package": "@probitas-test/client-connectrpc", "refersToTypeParameter": true } }, { "id": 574, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Call options" } ] }, "type": { "type": "reference", "target": 621, "name": "ConnectRpcOptions", "package": "@probitas-test/client-connectrpc" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 627, "name": "ConnectRpcResponse", "package": "@probitas-test/client-connectrpc" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 582, "name": "clientStream", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 583, "name": "clientStream", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Make a client streaming RPC call." } ] }, "typeParameters": [ { "id": 584, "name": "TRequest", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 585, "name": "serviceName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Service name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 586, "name": "methodName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Method name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 587, "name": "requests", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Async iterable of request messages" } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2018.asynciterable.d.ts", "qualifiedName": "AsyncIterable" }, "typeArguments": [ { "type": "reference", "target": 584, "name": "TRequest", "package": "@probitas-test/client-connectrpc", "refersToTypeParameter": true } ], "name": "AsyncIterable", "package": "typescript" } }, { "id": 588, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Call options" } ] }, "type": { "type": "reference", "target": 621, "name": "ConnectRpcOptions", "package": "@probitas-test/client-connectrpc" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 627, "name": "ConnectRpcResponse", "package": "@probitas-test/client-connectrpc" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 596, "name": "close", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 597, "name": "close", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Close the client connection." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 575, "name": "serverStream", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 576, "name": "serverStream", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Make a server streaming RPC call." } ] }, "typeParameters": [ { "id": 577, "name": "TRequest", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 578, "name": "serviceName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Service name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 579, "name": "methodName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Method name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 580, "name": "request", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Request message" } ] }, "type": { "type": "reference", "target": 577, "name": "TRequest", "package": "@probitas-test/client-connectrpc", "refersToTypeParameter": true } }, { "id": 581, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Call options" } ] }, "type": { "type": "reference", "target": 621, "name": "ConnectRpcOptions", "package": "@probitas-test/client-connectrpc" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2018.asynciterable.d.ts", "qualifiedName": "AsyncIterable" }, "typeArguments": [ { "type": "reference", "target": 627, "name": "ConnectRpcResponse", "package": "@probitas-test/client-connectrpc" } ], "name": "AsyncIterable", "package": "typescript" } } ] } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.esnext.disposable.d.ts", "qualifiedName": "AsyncDisposable" }, "name": "AsyncDisposable", "package": "typescript" } ] }, { "id": 554, "name": "GrpcClientConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Configuration for creating a gRPC client.\n\nThis is a subset of ConnectRpcClientConfig with protocol fixed to \"grpc\"." } ] }, "children": [ { "id": 556, "name": "httpVersion", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP version to use." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n\"2\"\n```" } ] } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client-connectrpc", "packagePath": "dist/types.d.ts", "qualifiedName": "HttpVersion" }, "name": "HttpVersion", "package": "@probitas-test/client-connectrpc" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Omit.httpVersion", "package": "@probitas-test/client-connectrpc" } }, { "id": 558, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Default metadata to send with every request." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "HeadersInit" }, "name": "HeadersInit", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Omit.metadata", "package": "@probitas-test/client-connectrpc" } }, { "id": 564, "name": "retry", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Retry configuration." } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "RetryOptions" }, "name": "RetryOptions", "package": "@probitas-test/client" }, "inheritedFrom": { "type": "reference", "target": 626, "name": "Omit.retry", "package": "@probitas-test/client", "qualifiedName": "CommonOptions.retry" } }, { "id": 559, "name": "schema", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Schema resolution configuration.\n- \"reflection\": Use Server Reflection to discover services dynamically (default)\n- string: Path to FileDescriptorSet binary file (from " }, { "kind": "code", "text": "`buf build --output set.binpb`" }, { "kind": "text", "text": ")\n- Uint8Array: FileDescriptorSet binary data\n- FileDescriptorSet: Pre-parsed FileDescriptorSet message object" } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n\"reflection\"\n```" } ] } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Uint8Array" }, "typeArguments": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "ArrayBufferLike" }, "name": "ArrayBufferLike", "package": "typescript" } ], "name": "Uint8Array", "package": "typescript" }, { "type": "reference", "target": { "packageName": "@bufbuild/protobuf", "packagePath": "dist/esm/wkt/google/protobuf/descriptor_pb.d.ts", "qualifiedName": "FileDescriptorSet" }, "name": "FileDescriptorSet", "package": "@bufbuild/protobuf" } ] }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Omit.schema", "package": "@probitas-test/client-connectrpc" } }, { "id": 563, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "AbortSignal for cancellation." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 625, "name": "Omit.signal", "package": "@probitas-test/client", "qualifiedName": "CommonOptions.signal" } }, { "id": 561, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to throw ConnectRpcError on non-OK responses (code !== 0) or failures.\nCan be overridden per-request via ConnectRpcOptions.throwOnError." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Omit.throwOnError", "package": "@probitas-test/client-connectrpc" } }, { "id": 562, "name": "timeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Timeout in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 624, "name": "Omit.timeout", "package": "@probitas-test/client", "qualifiedName": "CommonOptions.timeout" } }, { "id": 557, "name": "tls", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "TLS configuration. If not provided, uses insecure credentials." } ] }, "type": { "type": "reference", "target": 727, "name": "TlsConfig", "package": "@probitas-test/client-connectrpc" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Omit.tls", "package": "@probitas-test/client-connectrpc" } }, { "id": 555, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Server URL for ConnectRPC connections.\n\nCan be a URL string or a connection configuration object." } ], "blockTags": [ { "tag": "@example", "name": "String URL", "content": [ { "kind": "code", "text": "```ts\nimport type { ConnectRpcClientConfig } from \"@probitas-test/client-connectrpc\";\nconst config: ConnectRpcClientConfig = { url: \"http://localhost:50051\" };\n```" } ] }, { "tag": "@example", "name": "Connection config object", "content": [ { "kind": "code", "text": "```ts\nimport type { ConnectRpcClientConfig } from \"@probitas-test/client-connectrpc\";\nconst config: ConnectRpcClientConfig = {\n url: { host: \"grpc.example.com\", port: 443, protocol: \"https\" },\n};\n```" } ] } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "packageName": "@probitas-test/client-connectrpc", "packagePath": "dist/types.d.ts", "qualifiedName": "ConnectRpcConnectionConfig" }, "name": "ConnectRpcConnectionConfig", "package": "@probitas-test/client-connectrpc" } ] }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Omit.url", "package": "@probitas-test/client-connectrpc" } }, { "id": 560, "name": "useBinaryFormat", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to use binary format for messages." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\ntrue\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Omit.useBinaryFormat", "package": "@probitas-test/client-connectrpc" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-connectrpc", "packagePath": "dist/types.d.ts", "qualifiedName": "ConnectRpcClientConfig" }, "name": "ConnectRpcClientConfig", "package": "@probitas-test/client-connectrpc" }, { "type": "literal", "value": "protocol" } ], "name": "Omit", "package": "typescript" } ] }, { "id": 611, "name": "GrpcErrorOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for ConnectRpcError construction." } ] }, "children": [ { "id": 613, "name": "details", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Rich error details from google.rpc.Status." } ] }, "type": { "type": "union", "types": [ { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 688, "name": "ErrorDetail", "package": "@probitas-test/client-connectrpc" } } }, { "type": "literal", "value": null } ] } }, { "id": 612, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Headers/metadata from the ConnectRPC response." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "Headers" }, "name": "Headers", "package": "typescript" }, { "type": "literal", "value": null } ] } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es2022.error.d.ts", "qualifiedName": "ErrorOptions" }, "name": "ErrorOptions", "package": "typescript" } ] }, { "id": 621, "name": "GrpcOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for individual ConnectRPC calls." } ] }, "children": [ { "id": 622, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Metadata to send with the request." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "HeadersInit" }, "name": "HeadersInit", "package": "typescript" } }, { "id": 626, "name": "retry", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Retry configuration." } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "RetryOptions" }, "name": "RetryOptions", "package": "@probitas-test/client" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.retry" } }, { "id": 625, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "AbortSignal for cancellation." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.signal" } }, { "id": 623, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to throw ConnectRpcError on non-OK responses (code !== 0) or failures.\nOverrides ConnectRpcClientConfig.throwOnError." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse (inherited from client config if not specified)\n```" } ] } ] }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 624, "name": "timeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Timeout in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "CommonOptions.timeout" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client", "packagePath": "dist/types.d.ts", "qualifiedName": "CommonOptions" }, "name": "CommonOptions", "package": "@probitas-test/client" } ] }, { "id": 629, "name": "GrpcResponseError", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ConnectRPC response with gRPC error (statusCode !== 0).\n\nThe server processed the request but returned an error status." } ] }, "children": [ { "id": 639, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "No data for error responses." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.data", "package": "@probitas-test/client-connectrpc" } }, { "id": 641, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Response time in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 654, "name": "ConnectRpcResponseBase.duration", "package": "@probitas-test/client-connectrpc" } }, { "id": 633, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error information (null if successful).\n\nContains:\n- ConnectRpcError for gRPC errors\n- ConnectRpcNetworkError/AbortError/TimeoutError for failures" } ] }, "type": { "type": "reference", "target": 598, "name": "ConnectRpcError", "package": "@probitas-test/client-connectrpc" }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.error", "package": "@probitas-test/client-connectrpc" } }, { "id": 636, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Response headers." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "Headers" }, "name": "Headers", "package": "typescript" } }, { "id": 640, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nAlways " }, { "kind": "code", "text": "`\"connectrpc\"`" }, { "kind": "text", "text": " for ConnectRPC responses. Use this in switch statements\nfor type-safe narrowing of union types." } ] }, "type": { "type": "literal", "value": "connectrpc" }, "inheritedFrom": { "type": "reference", "target": 653, "name": "ConnectRpcResponseBase.kind", "package": "@probitas-test/client-connectrpc" } }, { "id": 632, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the request was successful.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": statusCode === 0 (OK)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": gRPC error or request failure" } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.ok", "package": "@probitas-test/client-connectrpc" } }, { "id": 631, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the request was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server responded (success or gRPC error)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before processing (network error, connection refused)" } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.processed", "package": "@probitas-test/client-connectrpc" } }, { "id": 638, "name": "raw", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Raw ConnectError." } ] }, "type": { "type": "reference", "target": { "packageName": "@connectrpc/connect", "packagePath": "dist/esm/connect-error.d.ts", "qualifiedName": "ConnectError" }, "name": "ConnectError", "package": "@connectrpc/connect" }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.raw", "package": "@probitas-test/client-connectrpc" } }, { "id": 634, "name": "statusCode", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "gRPC status code (1-16)." } ] }, "type": { "type": "reference", "target": 687, "name": "ConnectRpcStatusCode", "package": "@probitas-test/client-connectrpc" } }, { "id": 635, "name": "statusMessage", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Status message describing the error." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 637, "name": "trailers", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Response trailers (sent at end of RPC)." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "Headers" }, "name": "Headers", "package": "typescript" } } ], "typeParameters": [ { "id": 630, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-connectrpc", "packagePath": "dist/response.d.ts", "qualifiedName": "ConnectRpcResponseBase" }, "typeArguments": [ { "type": "reference", "target": 630, "name": "T", "package": "@probitas-test/client-connectrpc", "qualifiedName": "ConnectRpcResponseError.T", "refersToTypeParameter": true } ], "name": "ConnectRpcResponseBase", "package": "@probitas-test/client-connectrpc" } ] }, { "id": 642, "name": "GrpcResponseFailure", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Failed ConnectRPC request (network error, connection refused, etc.).\n\nThe request did not reach gRPC processing." } ] }, "children": [ { "id": 652, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "No data (request didn't reach server)." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.data", "package": "@probitas-test/client-connectrpc" } }, { "id": 654, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Response time in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.duration" } }, { "id": 646, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error information (null if successful).\n\nContains:\n- ConnectRpcError for gRPC errors\n- ConnectRpcNetworkError/AbortError/TimeoutError for failures" } ] }, "type": { "type": "reference", "target": { "packageName": "@probitas-test/client-connectrpc", "packagePath": "dist/errors.d.ts", "qualifiedName": "ConnectRpcFailureError" }, "name": "ConnectRpcFailureError", "package": "@probitas-test/client-connectrpc" }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.error", "package": "@probitas-test/client-connectrpc" } }, { "id": 649, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Response headers (null for failures)." } ] }, "type": { "type": "literal", "value": null } }, { "id": 653, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nAlways " }, { "kind": "code", "text": "`\"connectrpc\"`" }, { "kind": "text", "text": " for ConnectRPC responses. Use this in switch statements\nfor type-safe narrowing of union types." } ] }, "type": { "type": "literal", "value": "connectrpc" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.kind" } }, { "id": 645, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the request was successful.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": statusCode === 0 (OK)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": gRPC error or request failure" } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.ok", "package": "@probitas-test/client-connectrpc" } }, { "id": 644, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the request was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server responded (success or gRPC error)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before processing (network error, connection refused)" } ] }, "type": { "type": "literal", "value": false }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.processed", "package": "@probitas-test/client-connectrpc" } }, { "id": 651, "name": "raw", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "No raw response (request didn't reach server)." } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.raw", "package": "@probitas-test/client-connectrpc" } }, { "id": 647, "name": "statusCode", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Status code (null for network failures)." } ] }, "type": { "type": "literal", "value": null } }, { "id": 648, "name": "statusMessage", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Status message (null for network failures)." } ] }, "type": { "type": "literal", "value": null } }, { "id": 650, "name": "trailers", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Response trailers (null for failures)." } ] }, "type": { "type": "literal", "value": null } } ], "typeParameters": [ { "id": 643, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-connectrpc", "packagePath": "dist/response.d.ts", "qualifiedName": "ConnectRpcResponseBase" }, "typeArguments": [ { "type": "reference", "target": 643, "name": "T", "package": "@probitas-test/client-connectrpc", "qualifiedName": "ConnectRpcResponseFailure.T", "refersToTypeParameter": true } ], "name": "ConnectRpcResponseBase", "package": "@probitas-test/client-connectrpc" } ] }, { "id": 655, "name": "GrpcResponseSuccess", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Successful ConnectRPC response (statusCode === 0)." } ] }, "children": [ { "id": 665, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Response data as plain JavaScript object (JSON representation)." } ] }, "type": { "type": "union", "types": [ { "type": "reference", "target": 656, "name": "T", "package": "@probitas-test/client-connectrpc", "qualifiedName": "ConnectRpcResponseSuccess.T", "refersToTypeParameter": true }, { "type": "literal", "value": null } ] }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.data", "package": "@probitas-test/client-connectrpc" } }, { "id": 667, "name": "duration", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Response time in milliseconds." } ] }, "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.duration" } }, { "id": 659, "name": "error", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Error information (null if successful).\n\nContains:\n- ConnectRpcError for gRPC errors\n- ConnectRpcNetworkError/AbortError/TimeoutError for failures" } ] }, "type": { "type": "literal", "value": null }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.error", "package": "@probitas-test/client-connectrpc" } }, { "id": 662, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Response headers." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "Headers" }, "name": "Headers", "package": "typescript" } }, { "id": 666, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Result kind discriminator.\n\nAlways " }, { "kind": "code", "text": "`\"connectrpc\"`" }, { "kind": "text", "text": " for ConnectRPC responses. Use this in switch statements\nfor type-safe narrowing of union types." } ] }, "type": { "type": "literal", "value": "connectrpc" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.kind" } }, { "id": 658, "name": "ok", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the request was successful.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": statusCode === 0 (OK)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": gRPC error or request failure" } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.ok", "package": "@probitas-test/client-connectrpc" } }, { "id": 657, "name": "processed", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the request was processed by the server.\n\n- " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ": Server responded (success or gRPC error)\n- " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ": Request failed before processing (network error, connection refused)" } ] }, "type": { "type": "literal", "value": true }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.processed", "package": "@probitas-test/client-connectrpc" } }, { "id": 664, "name": "raw", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Raw protobuf Message object." } ] }, "type": { "type": "intrinsic", "name": "unknown" }, "overwrites": { "type": "reference", "target": -1, "name": "ConnectRpcResponseBase.raw", "package": "@probitas-test/client-connectrpc" } }, { "id": 660, "name": "statusCode", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "gRPC status code (always 0 for success)." } ] }, "type": { "type": "literal", "value": 0 } }, { "id": 661, "name": "statusMessage", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Status message (null for successful responses)." } ] }, "type": { "type": "literal", "value": null } }, { "id": 663, "name": "trailers", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Response trailers (sent at end of RPC)." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.dom.d.ts", "qualifiedName": "Headers" }, "name": "Headers", "package": "typescript" } } ], "typeParameters": [ { "id": 656, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "extendedTypes": [ { "type": "reference", "target": { "packageName": "@probitas-test/client-connectrpc", "packagePath": "dist/response.d.ts", "qualifiedName": "ConnectRpcResponseBase" }, "typeArguments": [ { "type": "reference", "target": 656, "name": "T", "package": "@probitas-test/client-connectrpc", "qualifiedName": "ConnectRpcResponseSuccess.T", "refersToTypeParameter": true } ], "name": "ConnectRpcResponseBase", "package": "@probitas-test/client-connectrpc" } ] }, { "id": 698, "name": "MethodInfo", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Method information from reflection." } ] }, "children": [ { "id": 704, "name": "idempotent", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the method is idempotent" } ] }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 702, "name": "inputType", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Input message type name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 701, "name": "kind", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Method kind" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "unary" }, { "type": "literal", "value": "server_streaming" }, { "type": "literal", "value": "client_streaming" }, { "type": "literal", "value": "bidi_streaming" } ] } }, { "id": 700, "name": "localName", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Local name (camelCase)" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 699, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Method name (e.g., \"Echo\")" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 703, "name": "outputType", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Output message type name" } ] }, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 705, "name": "ReflectionApi", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Reflection API for ConnectRPC client.\nOnly available when client is created with schema: \"reflection\"." } ] }, "children": [ { "id": 706, "name": "enabled", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Check if reflection is enabled." } ] }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 709, "name": "getServiceInfo", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 710, "name": "getServiceInfo", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Get detailed information about a specific service." } ], "blockTags": [ { "tag": "@throws", "content": [ { "kind": "text", "text": "Error if reflection is not enabled" } ] } ] }, "parameters": [ { "id": 711, "name": "serviceName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Fully qualified service name (e.g., \"echo.EchoService\")" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 718, "name": "ServiceDetail", "package": "@probitas-test/client-connectrpc" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 715, "name": "hasService", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 716, "name": "hasService", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Check if a service exists." } ], "blockTags": [ { "tag": "@throws", "content": [ { "kind": "text", "text": "Error if reflection is not enabled" } ] } ] }, "parameters": [ { "id": 717, "name": "serviceName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Fully qualified service name" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "boolean" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 712, "name": "listMethods", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 713, "name": "listMethods", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Get methods for a specific service." } ], "blockTags": [ { "tag": "@throws", "content": [ { "kind": "text", "text": "Error if reflection is not enabled" } ] } ] }, "parameters": [ { "id": 714, "name": "serviceName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Fully qualified service name" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "target": 698, "name": "MethodInfo", "package": "@probitas-test/client-connectrpc" } } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 707, "name": "listServices", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { "id": 708, "name": "listServices", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "List all available services on the server." } ], "blockTags": [ { "tag": "@throws", "content": [ { "kind": "text", "text": "Error if reflection is not enabled" } ] } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "target": 724, "name": "ServiceInfo", "package": "@probitas-test/client-connectrpc" } } ], "name": "Promise", "package": "typescript" } } ] } ] }, { "id": 718, "name": "ServiceDetail", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Detailed service information." } ] }, "children": [ { "id": 720, "name": "fullName", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Fully qualified service name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 723, "name": "methods", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "All methods" } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "reference", "target": 698, "name": "MethodInfo", "package": "@probitas-test/client-connectrpc" } } } }, { "id": 719, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Service name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 721, "name": "packageName", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Package name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 722, "name": "protoFile", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Proto file name" } ] }, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 724, "name": "ServiceInfo", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Service information from reflection." } ] }, "children": [ { "id": 726, "name": "file", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Proto file name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 725, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Fully qualified service name (e.g., \"echo.EchoService\")" } ] }, "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 727, "name": "TlsConfig", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "TLS configuration for ConnectRPC connections." } ] }, "children": [ { "id": 729, "name": "clientCert", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Client certificate (PEM format)." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Uint8Array" }, "typeArguments": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "ArrayBufferLike" }, "name": "ArrayBufferLike", "package": "typescript" } ], "name": "Uint8Array", "package": "typescript" } }, { "id": 730, "name": "clientKey", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Client private key (PEM format)." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Uint8Array" }, "typeArguments": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "ArrayBufferLike" }, "name": "ArrayBufferLike", "package": "typescript" } ], "name": "Uint8Array", "package": "typescript" } }, { "id": 731, "name": "insecure", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Skip server certificate verification (use only for testing)." } ] }, "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 728, "name": "rootCerts", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isReadonly": true }, "comment": { "summary": [ { "kind": "text", "text": "Root CA certificate (PEM format)." } ] }, "type": { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "Uint8Array" }, "typeArguments": [ { "type": "reference", "target": { "packageName": "typescript", "packagePath": "lib/lib.es5.d.ts", "qualifiedName": "ArrayBufferLike" }, "name": "ArrayBufferLike", "package": "typescript" } ], "name": "Uint8Array", "package": "typescript" } } ] }, { "id": 691, "name": "FileDescriptorSet", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "FileDescriptorSet message type from @bufbuild/protobuf.\nThis is the decoded protobuf message containing file descriptors." } ] }, "type": { "type": "reference", "target": { "packageName": "@bufbuild/protobuf", "packagePath": "dist/esm/types.d.ts", "qualifiedName": "MessageShape" }, "typeArguments": [ { "type": "query", "queryType": { "type": "reference", "target": { "packageName": "@bufbuild/protobuf", "packagePath": "dist/esm/wkt/google/protobuf/descriptor_pb.d.ts", "qualifiedName": "FileDescriptorSetSchema" }, "name": "FileDescriptorSetSchema", "package": "@bufbuild/protobuf", "preferValues": true } } ], "name": "MessageShape", "package": "@bufbuild/protobuf" } }, { "id": 627, "name": "GrpcResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ConnectRPC response union type.\n\nUse " }, { "kind": "code", "text": "`processed`" }, { "kind": "text", "text": " to distinguish between server responses and failures:\n- " }, { "kind": "code", "text": "`processed === true`" }, { "kind": "text", "text": ": Server responded (Success or Error)\n- " }, { "kind": "code", "text": "`processed === false`" }, { "kind": "text", "text": ": Request failed (Failure)\n\nUse " }, { "kind": "code", "text": "`ok`" }, { "kind": "text", "text": " to check for success:\n- " }, { "kind": "code", "text": "`ok === true`" }, { "kind": "text", "text": ": Success (statusCode === 0)\n- " }, { "kind": "code", "text": "`ok === false`" }, { "kind": "text", "text": ": Error or Failure" } ] }, "typeParameters": [ { "id": 628, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 655, "typeArguments": [ { "type": "reference", "target": 628, "name": "T", "package": "@probitas-test/client-connectrpc", "refersToTypeParameter": true } ], "name": "ConnectRpcResponseSuccess", "package": "@probitas-test/client-connectrpc" }, { "type": "reference", "target": 629, "typeArguments": [ { "type": "reference", "target": 628, "name": "T", "package": "@probitas-test/client-connectrpc", "refersToTypeParameter": true } ], "name": "ConnectRpcResponseError", "package": "@probitas-test/client-connectrpc" }, { "type": "reference", "target": 642, "typeArguments": [ { "type": "reference", "target": 628, "name": "T", "package": "@probitas-test/client-connectrpc", "refersToTypeParameter": true } ], "name": "ConnectRpcResponseFailure", "package": "@probitas-test/client-connectrpc" } ] } }, { "id": 687, "name": "GrpcStatusCode", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ConnectRPC/gRPC status code type.\nDerived from ConnectRpcStatus values." } ] }, "type": { "type": "indexedAccess", "indexType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "query", "queryType": { "type": "reference", "target": 668, "name": "ConnectRpcStatus", "package": "@probitas-test/client-connectrpc" } } }, "objectType": { "type": "query", "queryType": { "type": "reference", "target": 668, "name": "ConnectRpcStatus", "package": "@probitas-test/client-connectrpc" } } } }, { "id": 668, "name": "GrpcStatus", "variant": "declaration", "kind": 32, "flags": { "isConst": true }, "comment": { "summary": [ { "kind": "text", "text": "ConnectRPC/gRPC status codes.\nThese codes are used by both gRPC and ConnectRPC protocols." } ] }, "type": { "type": "reflection", "declaration": { "id": 669, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 680, "name": "ABORTED", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 10 } }, { "id": 676, "name": "ALREADY_EXISTS", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 6 } }, { "id": 671, "name": "CANCELLED", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 1 } }, { "id": 685, "name": "DATA_LOSS", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 15 } }, { "id": 674, "name": "DEADLINE_EXCEEDED", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 4 } }, { "id": 679, "name": "FAILED_PRECONDITION", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 9 } }, { "id": 683, "name": "INTERNAL", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 13 } }, { "id": 673, "name": "INVALID_ARGUMENT", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 3 } }, { "id": 675, "name": "NOT_FOUND", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 5 } }, { "id": 670, "name": "OK", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 0 } }, { "id": 681, "name": "OUT_OF_RANGE", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 11 } }, { "id": 677, "name": "PERMISSION_DENIED", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 7 } }, { "id": 678, "name": "RESOURCE_EXHAUSTED", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 8 } }, { "id": 686, "name": "UNAUTHENTICATED", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 16 } }, { "id": 684, "name": "UNAVAILABLE", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 14 } }, { "id": 682, "name": "UNIMPLEMENTED", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 12 } }, { "id": 672, "name": "UNKNOWN", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "type": { "type": "literal", "value": 2 } } ] } } }, { "id": 551, "name": "createGrpcClient", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 552, "name": "createGrpcClient", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Create a new gRPC client instance.\n\nThis is a thin wrapper around " }, { "kind": "code", "text": "`createConnectRpcClient`" }, { "kind": "text", "text": " with " }, { "kind": "code", "text": "`protocol: \"grpc\"`" }, { "kind": "text", "text": " fixed.\nThe client provides Server Reflection support for runtime service discovery." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A new gRPC client instance" } ] }, { "tag": "@example", "name": "Basic usage with reflection", "content": [ { "kind": "code", "text": "```ts\nimport { createGrpcClient } from \"@probitas-test/client-grpc\";\n\nconst client = createGrpcClient({\n url: \"http://localhost:50051\",\n});\n\n// Call a method\nconst response = await client.call(\n \"echo.EchoService\",\n \"echo\",\n { message: \"Hello!\" }\n);\nconsole.log(response.data);\n\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Service discovery with reflection", "content": [ { "kind": "code", "text": "```ts\nimport { createGrpcClient } from \"@probitas-test/client-grpc\";\n\nconst client = createGrpcClient({\n url: \"http://localhost:50051\",\n});\n\n// Discover available services\nconst services = await client.reflection.listServices();\nconsole.log(\"Available services:\", services);\n\n// Get method information\nconst info = await client.reflection.getServiceInfo(\"echo.EchoService\");\nconsole.log(\"Methods:\", info.methods);\n\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Testing error responses", "content": [ { "kind": "code", "text": "```ts\nimport { createGrpcClient } from \"@probitas-test/client-grpc\";\n\nconst client = createGrpcClient({ url: \"http://localhost:50051\" });\n\nconst response = await client.call(\n \"user.UserService\",\n \"getUser\",\n { id: \"non-existent\" },\n { throwOnError: false }\n);\n\nif (!response.ok) {\n console.log(\"Error code:\", response.statusCode); // NOT_FOUND = 5\n}\n\nawait client.close();\n```" } ] }, { "tag": "@example", "name": "Using `await using` for automatic cleanup", "content": [ { "kind": "code", "text": "```ts\nimport { createGrpcClient } from \"@probitas-test/client-grpc\";\n\nawait using client = createGrpcClient({\n url: \"http://localhost:50051\",\n});\n\nconst res = await client.call(\"echo.EchoService\", \"echo\", { message: \"test\" });\nconsole.log(res.data);\n// Client automatically closed when scope exits\n```" } ] } ] }, "parameters": [ { "id": 553, "name": "config", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Client configuration including server address" } ] }, "type": { "type": "reference", "target": 554, "name": "GrpcClientConfig", "package": "@probitas-test/client-grpc" } } ], "type": { "type": "reference", "target": 565, "name": "ConnectRpcClient", "package": "@probitas-test/client-connectrpc" } } ] }, { "id": 692, "name": "getGrpcStatusName", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 693, "name": "getGrpcStatusName", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Get the name of a ConnectRPC/gRPC status code." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```typescript\ngetStatusName(0); // \"OK\"\ngetStatusName(5); // \"NOT_FOUND\"\ngetStatusName(16); // \"UNAUTHENTICATED\"\n```" } ] } ] }, "parameters": [ { "id": 694, "name": "code", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 687, "name": "ConnectRpcStatusCode", "package": "@probitas-test/client-connectrpc" } } ], "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 695, "name": "isGrpcStatusCode", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { "id": 696, "name": "isGrpcStatusCode", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Check if a number is a valid ConnectRPC/gRPC status code." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```typescript\nisConnectRpcStatusCode(0); // true\nisConnectRpcStatusCode(16); // true\nisConnectRpcStatusCode(99); // false\n```" } ] } ] }, "parameters": [ { "id": 697, "name": "code", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "predicate", "name": "code", "asserts": false, "targetType": { "type": "reference", "target": 687, "name": "ConnectRpcStatusCode", "package": "@probitas-test/client-connectrpc" } } } ] } ], "packageName": "@probitas-test/client-grpc", "packageVersion": "0.6.2" }